mkdocs-recently-updated-docs 0.1__tar.gz

mkdocs_recently_updated_docs-0.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Aaron Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

mkdocs_recently_updated_docs-0.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: mkdocs-recently-updated-docs
+Version: 0.1
+Summary: A MkDocs plugin to show recently updated documents
+Home-page: https://github.com/jaywhj/mkdocs-recently-updated-docs
+Author: Aaron Wang
+Author-email: aaronwqt@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.1.0
+Requires-Dist: mkdocs_document_dates>=3.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# mkdocs-recently-updated-docs
+
+English | [简体中文](README_zh.md)
+
+
+
+One line of code to display a list of recently updated documents
+
+## Features
+
+- Supports display of recently updated documents in an overall list
+- Flexible display position (`sidebar` or `in md document`)
+- Rich template examples
+- Works well for any environment (no-Git, Git, all CI/CD build systems, etc)
+
+## Preview
+
+![recently-updated](recently-updated.png)
+
+## Installation
+
+```bash
+pip install mkdocs-recently-updated-docs
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - recently-updated
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - recently-updated:
+      limit: 10          # Limit the number of docs displayed
+      exclude:           # List of excluded files
+        - index.md       # Exclude specific file
+        - drafts/*       # Exclude all files in drafts folder, including subfolders
+      template: templates/recently_updated_list.html    # Custom rendering template
+```
+
+## Usage
+
+Just write this line in your md document anywhere:
+
+```markdown
+<!-- RECENTLY_UPDATED_DOCS -->
+```
+
+## Custom template
+
+See [templates](https://github.com/jaywhj/mkdocs-recently-updated-docs/tree/main/mkdocs_recently_updated_docs/templates) directory
+
+<br />
+
+## Other plugins
+
+[mkdocs-document-dates](https://github.com/jaywhj/mkdocs-document-dates)
+
+A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+
+![render](render.gif)

mkdocs_recently_updated_docs-0.1/README.md

@@ -0,0 +1,67 @@
+# mkdocs-recently-updated-docs
+
+English | [简体中文](README_zh.md)
+
+
+
+One line of code to display a list of recently updated documents
+
+## Features
+
+- Supports display of recently updated documents in an overall list
+- Flexible display position (`sidebar` or `in md document`)
+- Rich template examples
+- Works well for any environment (no-Git, Git, all CI/CD build systems, etc)
+
+## Preview
+
+![recently-updated](recently-updated.png)
+
+## Installation
+
+```bash
+pip install mkdocs-recently-updated-docs
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - recently-updated
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - recently-updated:
+      limit: 10          # Limit the number of docs displayed
+      exclude:           # List of excluded files
+        - index.md       # Exclude specific file
+        - drafts/*       # Exclude all files in drafts folder, including subfolders
+      template: templates/recently_updated_list.html    # Custom rendering template
+```
+
+## Usage
+
+Just write this line in your md document anywhere:
+
+```markdown
+<!-- RECENTLY_UPDATED_DOCS -->
+```
+
+## Custom template
+
+See [templates](https://github.com/jaywhj/mkdocs-recently-updated-docs/tree/main/mkdocs_recently_updated_docs/templates) directory
+
+<br />
+
+## Other plugins
+
+[mkdocs-document-dates](https://github.com/jaywhj/mkdocs-document-dates)
+
+A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+
+![render](render.gif)

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs/plugin.py

@@ -0,0 +1,62 @@
+from jinja2 import Environment, FileSystemLoader, select_autoescape
+from pathlib import Path
+from mkdocs.plugins import BasePlugin
+from mkdocs.config import config_options
+from mkdocs_document_dates.utils import get_recently_modified_files
+
+
+class RecentlyUpdatedPlugin(BasePlugin):
+    config_scheme = (
+        ('limit', config_options.Type(int, default=10)),
+        ('exclude', config_options.Type(list, default=[])),
+        ('template', config_options.Type(str, default=''))
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        self.recent_docs_html = None
+
+    def on_nav(self, nav, config, files):
+        limit = self.config.get('limit')
+        exclude_list = self.config.get('exclude')
+        template_path = self.config.get("template")
+
+        # 获取 docs 目录下最近更新的文档
+        recently_modified_files = get_recently_modified_files(files, exclude_list, limit)
+
+        # 渲染HTML
+        docs_dir = Path(config['docs_dir'])
+        self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_modified_files)
+
+        return nav
+
+    def _render_recently_updated_html(self, docs_dir, template_path, recently_updated_data):
+        # 获取自定义模板路径
+        if template_path:
+            user_full_path = docs_dir / template_path
+
+        # 选择模板路径
+        if template_path and user_full_path.is_file():
+            template_dir = user_full_path.parent
+            template_file = user_full_path.name
+        else:
+            # 默认模板路径
+            default_template_path = Path(__file__).parent / 'templates' / 'recently_updated_list.html'
+            template_dir = default_template_path.parent
+            template_file = default_template_path.name
+
+        # 加载模板
+        env = Environment(
+            loader=FileSystemLoader(str(template_dir)),
+            autoescape=select_autoescape(["html", "xml"])
+        )
+        template = env.get_template(template_file)
+
+        # 渲染模板
+        return template.render(recent_docs=recently_updated_data)
+
+    def on_page_markdown(self, markdown, page, config, files):
+        if '<!-- RECENTLY_UPDATED_DOCS -->' in markdown:
+            markdown = markdown.replace('<!-- RECENTLY_UPDATED_DOCS -->', self.recent_docs_html or '')
+        return markdown

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs/templates/recently_updated_card.html

@@ -0,0 +1,48 @@
+<style>
+.recently-modified {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 10px;
+    margin: 20px 0;
+    padding: 0;
+}
+.recently-modified-item {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    padding: 0.5rem 0.75rem;
+    border: 1px solid rgba(142, 142, 142, 0.15);
+    border-radius: 2px;
+    min-height: 40px;
+    transition: box-shadow 0.2s ease;
+}
+.recently-modified-item:hover {
+    box-shadow: 0 4px 8px rgba(0,0,0,0.1);
+}
+.recently-modified-item a {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    height: 100%;
+    flex: 1;
+    text-decoration: none;
+    word-break: break-word;
+    color: #0077cc; 
+}
+.recently-modified-item span {
+    flex: 0 0 90px;
+    text-align: right;
+    color: rgba(142, 142, 142, 0.5);
+    font-size: 0.85rem;
+}
+.md-main .recently-modified-item span {
+    font-size: 0.7rem;
+}
+</style>
+<div class="recently-modified">
+    {%- for mtime, rel_path, title, url in recent_docs %}
+    <div class="recently-modified-item">
+        <a href="{{ url }}" target="_blank">{{ title }} <span>{{ mtime[:10] }}</span></a>
+    </div>
+    {%- endfor %}
+</div>

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs/templates/recently_updated_list.html

@@ -0,0 +1,42 @@
+<style>
+.recently-updated {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 10px;
+    margin: 0;
+    padding: 16px;
+    border: 1px solid rgba(142, 142, 142, 0.15);
+    border-radius: 4px;
+    font-family: system-ui, sans-serif;
+}
+.recently-updated-item {
+    display: flex;
+    align-items: center;
+}
+.recently-updated-item span {
+    font-size: 0.85em;
+    color: rgba(142, 142, 142, 0.5);
+    margin-right: 8px;
+    flex-shrink: 0;
+    width: 90px;
+}
+.recently-updated-item a {
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+    color: #0077cc;
+    text-decoration: none;
+    transition: color 0.2s ease;
+}
+.recently-updated-item a:hover {
+    text-decoration: underline;
+}
+</style>
+<div class="recently-updated">
+    {%- for mtime, rel_path, title, url in recent_docs %}
+    <div class="recently-updated-item">
+        <span>{{ mtime[:10] }}</span>
+        <a href="{{ url }}" target="_blank">{{ title }}</a>
+    </div>
+    {%- endfor %}
+</div>

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: mkdocs-recently-updated-docs
+Version: 0.1
+Summary: A MkDocs plugin to show recently updated documents
+Home-page: https://github.com/jaywhj/mkdocs-recently-updated-docs
+Author: Aaron Wang
+Author-email: aaronwqt@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.1.0
+Requires-Dist: mkdocs_document_dates>=3.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# mkdocs-recently-updated-docs
+
+English | [简体中文](README_zh.md)
+
+
+
+One line of code to display a list of recently updated documents
+
+## Features
+
+- Supports display of recently updated documents in an overall list
+- Flexible display position (`sidebar` or `in md document`)
+- Rich template examples
+- Works well for any environment (no-Git, Git, all CI/CD build systems, etc)
+
+## Preview
+
+![recently-updated](recently-updated.png)
+
+## Installation
+
+```bash
+pip install mkdocs-recently-updated-docs
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - recently-updated
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - recently-updated:
+      limit: 10          # Limit the number of docs displayed
+      exclude:           # List of excluded files
+        - index.md       # Exclude specific file
+        - drafts/*       # Exclude all files in drafts folder, including subfolders
+      template: templates/recently_updated_list.html    # Custom rendering template
+```
+
+## Usage
+
+Just write this line in your md document anywhere:
+
+```markdown
+<!-- RECENTLY_UPDATED_DOCS -->
+```
+
+## Custom template
+
+See [templates](https://github.com/jaywhj/mkdocs-recently-updated-docs/tree/main/mkdocs_recently_updated_docs/templates) directory
+
+<br />
+
+## Other plugins
+
+[mkdocs-document-dates](https://github.com/jaywhj/mkdocs-document-dates)
+
+A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+
+![render](render.gif)

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+mkdocs_recently_updated_docs/__init__.py
+mkdocs_recently_updated_docs/plugin.py
+mkdocs_recently_updated_docs.egg-info/PKG-INFO
+mkdocs_recently_updated_docs.egg-info/SOURCES.txt
+mkdocs_recently_updated_docs.egg-info/dependency_links.txt
+mkdocs_recently_updated_docs.egg-info/entry_points.txt
+mkdocs_recently_updated_docs.egg-info/requires.txt
+mkdocs_recently_updated_docs.egg-info/top_level.txt
+mkdocs_recently_updated_docs/templates/recently_updated_card.html
+mkdocs_recently_updated_docs/templates/recently_updated_list.html

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+recently-updated = mkdocs_recently_updated_docs.plugin:RecentlyUpdatedPlugin

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/requires.txt

@@ -0,0 +1,2 @@
+mkdocs>=1.1.0
+mkdocs_document_dates>=3.4

mkdocs_recently_updated_docs-0.1/mkdocs_recently_updated_docs.egg-info/top_level.txt

@@ -0,0 +1 @@
+mkdocs_recently_updated_docs

mkdocs_recently_updated_docs-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mkdocs_recently_updated_docs-0.1/setup.py

@@ -0,0 +1,35 @@
+from setuptools import setup, find_packages
+
+VERSION = '0.1'
+
+setup(
+    name="mkdocs-recently-updated-docs",
+    version=VERSION,
+    author="Aaron Wang",
+    author_email="aaronwqt@gmail.com",
+    license="MIT",
+    description="A MkDocs plugin to show recently updated documents",
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/jaywhj/mkdocs-recently-updated-docs",
+    packages=find_packages(),
+    install_requires=[
+        'mkdocs>=1.1.0',
+        'mkdocs_document_dates>=3.4',
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+    entry_points={
+        'mkdocs.plugins': [
+            'recently-updated = mkdocs_recently_updated_docs.plugin:RecentlyUpdatedPlugin',
+        ]
+    },
+    package_data={
+        'mkdocs_recently_updated_docs': [
+            'templates/*'
+        ],
+    },
+    python_requires=">=3.7",
+)