mkdocs-document-dates 3.3.4__tar.gz → 3.4__tar.gz

{mkdocs_document_dates-3.3.4/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.3.4
+Version: 3.4
 Summary: A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -51,8 +51,9 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+- Supports display of recently updated documents in an overall list
 
-## Showcases
+## Preview
 
 ![render](render.gif)
 
@@ -83,14 +84,16 @@ plugins:
         - drafts/*             # Exclude all files in drafts folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
+      show_author: true        # Show author or not, default: true
 ```
 
 ## Specify time manually
 
-By default, the plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
+The plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
 
-- **Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
-- If you want to customize it, you can specify it manually in Front Matter:
+**Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
+
+- If need to customize it, you can specify it manually in Front Matter:
     ```markdown
     ---
     created: 2023-01-01
@@ -103,10 +106,11 @@ By default, the plugin will **automatically** get the exact time of the document
 
 ## Configure Author
 
-By default, the plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+The plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+
+**Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
 
-- **Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
-- If you want to customize it, you can configure an author in Front Matter with the field `name`:
+- If need to customize it, you can configure an author in Front Matter with the field `name`:
     ```markdown
     ---
     name: any-name
@@ -117,7 +121,7 @@ By default, the plugin will **automatically** get the author of the document, an
 
 ## Configure Avatar
 
-By default, the plugin will **automatically** loads the author avatar, without manual intervention
+The plugin will **automatically** loads the author avatar, without manual intervention
 
 **Priority**: `Custom Avatar` > `GitHub Avatar` > `Character Avatar`
 
@@ -144,12 +148,13 @@ By default, the plugin will **automatically** loads the author avatar, without m
     
     ---
     ```
-- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` directory, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
+
+- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` folder, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
 - If the URL avatar fails to load, it automatically falls back to the character avatar
 
 ## Customization
 
-The plugin supports full customization, such as **icon style, theme color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
+The plugin supports full customization, such as **icon, theme, color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
 
 |        Category:        | Location:                               |
 | :----------------------: | ---------------------------------------- |
@@ -160,15 +165,15 @@ The plugin supports full customization, such as **icon style, theme color, font,
 
 ## Localization
 
-- **tooltip**: the plugin has 10 built-in languages: `en zh zh_TW es fr de ar ja ko ru`, **no need for manual configuration**, intelligent recognition, automatic switching
-    - If the language is missing or the built-in language is inaccurate, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to register and add it yourself, or submit an issue
-    - The original configuration option `locale` is retained, but manual configuration is no longer recommended
-- **timeago**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
-    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), register and add it yourself
+- <mark>tooltip</mark>: built-in languages: `en zh zh_TW es fr de ar ja ko ru nl pt`, **no need to manually configure**, intelligent recognition, automatic switching
+    - If there is any missing language or inaccurate built-in language, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to add it by registering yourself, or submit PR for built-in
+    - The original configuration item `locale` has been retained, but manual configuration is no longer recommended
+- <mark>timeago</mark>: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
+    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), add it by registering yourself
     - In `mkdocs.yml`, configure the full version of `timeago.full.min.js` to reload all languages at once
         ```yaml
         extra_javascript:
-        - assets/document_dates/core/timeago.full.min.js
+          - assets/document_dates/core/timeago.full.min.js
         ```
 
 ## Template Variables
@@ -178,12 +183,22 @@ You can access the meta-info of a document in a template using the following var
 - page.meta.document_dates_created
 - page.meta.document_dates_modified
 - page.meta.document_dates_authors
+- config.extra.recently_updated_docs
 
 Usage examples:
 
 - **Example 1**: Set the correct `lastmod` for your site's `sitemap.xml` so that search engines can better handle SEO and thus increase your site's exposure (download [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/sitemap.xml) and override this path: `docs/overrides/sitemap.xml`)
 - **Example 2**: Using the template to re-customize the plugin, you have full control over the rendering logic and the plugin is only responsible for providing the data (download [source-file.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/source-file.html) and override this path: `docs/overrides/partials/source-file.html`)
 
+## Recently updated module
+
+You can get the recently updated document data use `config.extra.recently_updated_docs` in any template, then customize the rendering logic yourself, or use the preset template examples directly:
+
+- **Example 1**: Add the recently updated module to the navigation of the sidebar (download [nav.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/nav.html) and override this path: `docs/overrides/partials/nav.html`)
+- **Example 2**: Add this feature anywhere in any md document, you can install the plugin [mkdocs-recently-updated-docs](https://github.com/jaywhj/mkdocs-recently-updated-docs), which is also based on the data capabilities provided by this plugin and provides more template examples, making it easier to use
+
+![recently-updated](recently-updated.png)
+
 ## Other Tips
 
 - In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
@@ -216,10 +231,10 @@ A dispensable, insignificant little plug-in, friends who have time can take a lo
         - Solution: Reduce the number of I/Os + Use caching + Replace less efficient system functions
 - **Improve**:
     - Since it's a newly developed plugin, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity, personalization, intelligence**
-        - **Ease of use**: there are no complex configurations, only 2-3 commonly used configuration options, in addition, a template is provided for personalized configurations
+        - **Ease of use**: no complex configuration, only 2-3 commonly used configuration items, in addition to providing the reference template for personalized configurations
         - **Simplicity**: no unnecessary configuration, no Git dependencies, no CI/CD configuration dependencies, no other package dependencies
         - **Personalization**: fully customizable and full control over the rendering logic, the plugin is only responsible for providing the data
-        - **Intelligence**: intelligently parse document time, author, avatar, intelligent recognition of user language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
+        - **Intelligence**: Intelligent parsing of document time, author, avatar, intelligent recognition of the user's language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
         - **Compatibility**: works well on older operating systems and browsers, such as WIN7, MacOS 10.11, iOS 12, Chrome 63.0.3239
 - **The Last Secret**:
     - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/README.md

@@ -25,8 +25,9 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+- Supports display of recently updated documents in an overall list
 
-## Showcases
+## Preview
 
 ![render](render.gif)
 
@@ -57,14 +58,16 @@ plugins:
         - drafts/*             # Exclude all files in drafts folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
+      show_author: true        # Show author or not, default: true
 ```
 
 ## Specify time manually
 
-By default, the plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
+The plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
 
-- **Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
-- If you want to customize it, you can specify it manually in Front Matter:
+**Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
+
+- If need to customize it, you can specify it manually in Front Matter:
     ```markdown
     ---
     created: 2023-01-01
@@ -77,10 +80,11 @@ By default, the plugin will **automatically** get the exact time of the document
 
 ## Configure Author
 
-By default, the plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+The plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+
+**Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
 
-- **Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
-- If you want to customize it, you can configure an author in Front Matter with the field `name`:
+- If need to customize it, you can configure an author in Front Matter with the field `name`:
     ```markdown
     ---
     name: any-name
@@ -91,7 +95,7 @@ By default, the plugin will **automatically** get the author of the document, an
 
 ## Configure Avatar
 
-By default, the plugin will **automatically** loads the author avatar, without manual intervention
+The plugin will **automatically** loads the author avatar, without manual intervention
 
 **Priority**: `Custom Avatar` > `GitHub Avatar` > `Character Avatar`
 
@@ -118,12 +122,13 @@ By default, the plugin will **automatically** loads the author avatar, without m
     
     ---
     ```
-- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` directory, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
+
+- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` folder, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
 - If the URL avatar fails to load, it automatically falls back to the character avatar
 
 ## Customization
 
-The plugin supports full customization, such as **icon style, theme color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
+The plugin supports full customization, such as **icon, theme, color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
 
 |        Category:        | Location:                               |
 | :----------------------: | ---------------------------------------- |
@@ -134,15 +139,15 @@ The plugin supports full customization, such as **icon style, theme color, font,
 
 ## Localization
 
-- **tooltip**: the plugin has 10 built-in languages: `en zh zh_TW es fr de ar ja ko ru`, **no need for manual configuration**, intelligent recognition, automatic switching
-    - If the language is missing or the built-in language is inaccurate, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to register and add it yourself, or submit an issue
-    - The original configuration option `locale` is retained, but manual configuration is no longer recommended
-- **timeago**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
-    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), register and add it yourself
+- <mark>tooltip</mark>: built-in languages: `en zh zh_TW es fr de ar ja ko ru nl pt`, **no need to manually configure**, intelligent recognition, automatic switching
+    - If there is any missing language or inaccurate built-in language, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to add it by registering yourself, or submit PR for built-in
+    - The original configuration item `locale` has been retained, but manual configuration is no longer recommended
+- <mark>timeago</mark>: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
+    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), add it by registering yourself
     - In `mkdocs.yml`, configure the full version of `timeago.full.min.js` to reload all languages at once
         ```yaml
         extra_javascript:
-        - assets/document_dates/core/timeago.full.min.js
+          - assets/document_dates/core/timeago.full.min.js
         ```
 
 ## Template Variables
@@ -152,12 +157,22 @@ You can access the meta-info of a document in a template using the following var
 - page.meta.document_dates_created
 - page.meta.document_dates_modified
 - page.meta.document_dates_authors
+- config.extra.recently_updated_docs
 
 Usage examples:
 
 - **Example 1**: Set the correct `lastmod` for your site's `sitemap.xml` so that search engines can better handle SEO and thus increase your site's exposure (download [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/sitemap.xml) and override this path: `docs/overrides/sitemap.xml`)
 - **Example 2**: Using the template to re-customize the plugin, you have full control over the rendering logic and the plugin is only responsible for providing the data (download [source-file.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/source-file.html) and override this path: `docs/overrides/partials/source-file.html`)
 
+## Recently updated module
+
+You can get the recently updated document data use `config.extra.recently_updated_docs` in any template, then customize the rendering logic yourself, or use the preset template examples directly:
+
+- **Example 1**: Add the recently updated module to the navigation of the sidebar (download [nav.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/nav.html) and override this path: `docs/overrides/partials/nav.html`)
+- **Example 2**: Add this feature anywhere in any md document, you can install the plugin [mkdocs-recently-updated-docs](https://github.com/jaywhj/mkdocs-recently-updated-docs), which is also based on the data capabilities provided by this plugin and provides more template examples, making it easier to use
+
+![recently-updated](recently-updated.png)
+
 ## Other Tips
 
 - In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
@@ -190,10 +205,10 @@ A dispensable, insignificant little plug-in, friends who have time can take a lo
         - Solution: Reduce the number of I/Os + Use caching + Replace less efficient system functions
 - **Improve**:
     - Since it's a newly developed plugin, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity, personalization, intelligence**
-        - **Ease of use**: there are no complex configurations, only 2-3 commonly used configuration options, in addition, a template is provided for personalized configurations
+        - **Ease of use**: no complex configuration, only 2-3 commonly used configuration items, in addition to providing the reference template for personalized configurations
         - **Simplicity**: no unnecessary configuration, no Git dependencies, no CI/CD configuration dependencies, no other package dependencies
         - **Personalization**: fully customizable and full control over the rendering logic, the plugin is only responsible for providing the data
-        - **Intelligence**: intelligently parse document time, author, avatar, intelligent recognition of user language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
+        - **Intelligence**: Intelligent parsing of document time, author, avatar, intelligent recognition of the user's language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
         - **Compatibility**: works well on older operating systems and browsers, such as WIN7, MacOS 10.11, iOS 12, Chrome 63.0.3239
 - **The Last Secret**:
-    - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)
+    - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/mkdocs_document_dates/plugin.py

@@ -8,7 +8,7 @@ from mkdocs.plugins import BasePlugin
 from mkdocs.config import config_options
 from mkdocs.structure.pages import Page
 from urllib.parse import urlparse
-from .utils import get_file_creation_time, load_git_cache, read_jsonl_cache
+from .utils import get_file_creation_time, load_git_cache, read_jsonl_cache,is_excluded, get_recently_modified_files
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
@@ -42,7 +42,8 @@ class DocumentDatesPlugin(BasePlugin):
         ('exclude', config_options.Type(list, default=[])),
         ('created_field_names', config_options.Type(list, default=['created', 'date', 'creation'])),
         ('modified_field_names', config_options.Type(list, default=['modified', 'updated', 'last_modified', 'last_updated'])),
-        ('show_author', config_options.Type(bool, default=True))
+        ('show_author', config_options.Type(bool, default=True)),
+        ('recently-updated', config_options.Type((dict, bool), default={}))
     )
 
     def __init__(self):
@@ -151,13 +152,34 @@ class DocumentDatesPlugin(BasePlugin):
 
         return config
 
+    def on_nav(self, nav, config, files):
+        recently_updated_config = self.config.get('recently-updated')
+        if not recently_updated_config:
+            return nav
+
+        # 兼容 true 配置
+        if recently_updated_config is True:
+            recently_updated_config = {}
+
+        # 获取配置
+        exclude_list = recently_updated_config.get('exclude', [])
+        limit = recently_updated_config.get('limit', 10)
+
+        # 获取 docs 目录下最近更新的文档
+        recently_modified_files = get_recently_modified_files(files, exclude_list, limit)
+
+        # 将数据注入到 config['extra'] 中供全局访问
+        if 'extra' not in config:
+            config['extra'] = {}
+        config['extra']['recently_updated_docs'] = recently_modified_files
+
+        return nav
+
     def on_page_markdown(self, markdown, page: Page, config, files):
         # 获取相对路径，src_uri 总是以"/"分隔
-        rel_path = getattr(page.file, 'src_uri', None)
-        if not rel_path:
-            rel_path = page.file.src_path
-            if os.sep != '/':
-                rel_path = rel_path.replace(os.sep, '/')
+        rel_path = getattr(page.file, 'src_uri', page.file.src_path)
+        if os.sep != '/':
+            rel_path = rel_path.replace(os.sep, '/')
         file_path = page.file.abs_src_path
         
         # 获取时间信息
@@ -177,7 +199,7 @@ class DocumentDatesPlugin(BasePlugin):
         page.meta['document_dates_authors'] = authors
         
         # 检查是否需要排除
-        if self._is_excluded(rel_path):
+        if is_excluded(rel_path, self.config['exclude']):
             return markdown
         
         # 生成日期和作者信息 HTML
@@ -217,17 +239,6 @@ class DocumentDatesPlugin(BasePlugin):
             logger.info(f"Error parsing .authors.yml: {e}")
 
 
-    def _is_excluded(self, rel_path):
-        for pattern in self.config['exclude']:
-            if pattern.endswith('*'):
-                if rel_path.startswith(pattern.partition('*')[0]):
-                    return True
-            else:
-                if rel_path == pattern:
-                    return True
-        return False
-
-
     def _find_meta_date(self, meta, field_names):
         for field in field_names:
             if field in meta:

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/mkdocs_document_dates/static/core/default.config.js

@@ -126,6 +126,18 @@ window.TooltipLanguage = (function () {
             author: "작성자",
             authors: "작성자"
         },
+        nl: {
+            created_time: "Gecreëerd",
+            modified_time: "Laatst geüpdatet",
+            author: "Auteur",
+            authors: "Auteurs"            
+        },
+        pt: {
+            created_time: "Criado em",
+            modified_time: "Última atualização",
+            author: "Autor",
+            authors: "Autores"
+        },
         ru: {
             created_time: "Дата создания",
             modified_time: "Дата изменения",
@@ -150,4 +162,4 @@ window.TooltipLanguage = (function () {
     Object.entries(defaultLanguages).forEach(([locale, data]) => {
         TooltipLanguage.register(locale, data);
     });
-})();
+})();

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/mkdocs_document_dates/static/fonts/material-icons.css

@@ -3,7 +3,9 @@
   font-style: normal;
   font-weight: 400;
   src: url(./materialicons.woff2) format('woff2'),
-       url(./materialicons.ttf) format('truetype');
+       url(https://fonts.gstatic.com/s/materialicons/v140/flUhRq6tzZclQEJ-Vdg-IuiaDsNc.woff2) format('woff2'),
+       url(https://fonts.gstatic.com/s/materialicons/v140/flUhRq6tzZclQEJ-Vdg-IuiaDsNa.woff) format('woff'),
+       url(https://fonts.gstatic.com/s/materialicons/v140/flUhRq6tzZclQEJ-Vdg-IuiaDsNZ.ttf) format('truetype');
 }
 
 .material-icons {

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/mkdocs_document_dates/utils.py

@@ -11,6 +11,18 @@ logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
 
 
+def is_excluded(path, exclude_list):
+    if not exclude_list:
+        return False
+    for pattern in exclude_list:
+        if pattern.endswith('*'):
+            if path.startswith(pattern.partition('*')[0]):
+                return True
+        else:
+            if path == pattern:
+                return True
+    return False
+
 def get_git_first_commit_time(file_path):
     try:
         # git log --reverse --format="%aI" -- {file_path} | head -n 1
@@ -35,8 +47,10 @@ def load_git_cache(docs_dir_path: Path):
                 text=True, encoding='utf-8'
             ).strip())
             docs_prefix = docs_dir_path.relative_to(git_root).as_posix()
+            docs_prefix_with_slash = docs_prefix + '/'
+            prefix_len = len(docs_prefix_with_slash)
 
-            authors_dict = defaultdict(set)
+            authors_dict = defaultdict(dict)
             first_commit = {}
             current_commit = None
 
@@ -46,21 +60,27 @@ def load_git_cache(docs_dir_path: Path):
                     continue
                 if '|' in line:
                     name, email, created = line.split('|', 2)
-                    current_commit = {'name': name, 'email': email, 'created': created}
+                    # 使用元组，更轻量
+                    current_commit = (name, email, created)
                 elif line.endswith('.md') and current_commit:
-                    if line.startswith(docs_prefix + '/'):
-                        line = line[len(docs_prefix) + 1:]
-                    authors_dict[line].add((current_commit['name'], current_commit['email']))
+                    if line.startswith(docs_prefix_with_slash):
+                        line = line[prefix_len:]
+                    # 解构元组，避免字典查找
+                    name, email, created = current_commit
+                    # 使用有序去重结构，保持作者首次出现顺序
+                    authors_dict[line].setdefault((name, email), None)
                     if line not in first_commit:
-                        first_commit[line] = current_commit['created']
+                        first_commit[line] = created
 
-            for file_path in sorted(first_commit):
+            # 构建最终的缓存数据
+            for file_path in first_commit:
+                authors_list = [
+                    {'name': name, 'email': email}
+                    for name, email in authors_dict[file_path].keys()
+                ]
                 dates_cache[file_path] = {
                     'created': first_commit[file_path],
-                    'authors': [
-                        {'name': name, 'email': email}
-                        for name, email in sorted(authors_dict[file_path])
-                        ]
+                    'authors': authors_list
                 }
     except Exception as e:
         logger.info(f"Error getting git info in {docs_dir_path}: {e}")
@@ -83,6 +103,38 @@ def get_file_creation_time(file_path):
         logger.error(f"Failed to get file creation time for {file_path}: {e}")
         return datetime.now()
 
+def get_recently_modified_files(files, exclude_list: list, limit: int = 10):
+    if not files:
+        return []
+    temp_results = []
+    for file in files:
+        if not file.src_path.endswith('.md'):
+            continue
+        rel_path = getattr(file, 'src_uri', file.src_path)
+        if os.sep != '/':
+            rel_path = rel_path.replace(os.sep, '/')
+        if is_excluded(rel_path, exclude_list):
+            continue
+
+        # 过滤没有配置进导航里的文档
+        if file.page:
+            if not file.page.title:
+                continue
+            title, url = file.page.title, file.page.url
+        else:
+            title, url = file.name, file.url
+
+        mtime = os.path.getmtime(file.abs_src_path)
+        temp_results.append((mtime, rel_path, title, url))
+
+    # 按修改时间倒序
+    temp_results.sort(key=lambda x: x[0], reverse=True)
+    results = [
+        (datetime.fromtimestamp(mtime).strftime("%Y-%m-%d %H:%M:%S"), *rest)
+        for mtime, *rest in temp_results
+    ]
+    return results[:limit]
+
 def read_json_cache(cache_file: Path):
     dates_cache = {}
     if cache_file.exists():

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.3.4
+Version: 3.4
 Summary: A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -51,8 +51,9 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 | git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+- Supports display of recently updated documents in an overall list
 
-## Showcases
+## Preview
 
 ![render](render.gif)
 
@@ -83,14 +84,16 @@ plugins:
         - drafts/*             # Exclude all files in drafts folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
+      show_author: true        # Show author or not, default: true
 ```
 
 ## Specify time manually
 
-By default, the plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
+The plugin will **automatically** get the exact time of the document, and will automatically cache the creation time, without manual intervention
 
-- **Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
-- If you want to customize it, you can specify it manually in Front Matter:
+**Priority**: `Front Matter` > `File System Timestamps(Cached)` > `Git Timestamps`
+
+- If need to customize it, you can specify it manually in Front Matter:
     ```markdown
     ---
     created: 2023-01-01
@@ -103,10 +106,11 @@ By default, the plugin will **automatically** get the exact time of the document
 
 ## Configure Author
 
-By default, the plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+The plugin will **automatically** get the author of the document, and will automatically parse the email and then do the link, without manual intervention
+
+**Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
 
-- **Priority**: `Front Matter` > `Git Author` > `site_author(mkdocs.yml)` > `PC Username`
-- If you want to customize it, you can configure an author in Front Matter with the field `name`:
+- If need to customize it, you can configure an author in Front Matter with the field `name`:
     ```markdown
     ---
     name: any-name
@@ -117,7 +121,7 @@ By default, the plugin will **automatically** get the author of the document, an
 
 ## Configure Avatar
 
-By default, the plugin will **automatically** loads the author avatar, without manual intervention
+The plugin will **automatically** loads the author avatar, without manual intervention
 
 **Priority**: `Custom Avatar` > `GitHub Avatar` > `Character Avatar`
 
@@ -144,12 +148,13 @@ By default, the plugin will **automatically** loads the author avatar, without m
     
     ---
     ```
-- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` directory, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
+
+- If you want to configure complete information for multiple authors, you can create a separate configuration file `authors.yml` in the `docs/` folder, see the [authors.yml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/authors.yml) for its format
 - If the URL avatar fails to load, it automatically falls back to the character avatar
 
 ## Customization
 
-The plugin supports full customization, such as **icon style, theme color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
+The plugin supports full customization, such as **icon, theme, color, font, animation, dividing line** etc, and the entrance has been preset, you just need to find the file below and uncomment it:
 
 |        Category:        | Location:                               |
 | :----------------------: | ---------------------------------------- |
@@ -160,15 +165,15 @@ The plugin supports full customization, such as **icon style, theme color, font,
 
 ## Localization
 
-- **tooltip**: the plugin has 10 built-in languages: `en zh zh_TW es fr de ar ja ko ru`, **no need for manual configuration**, intelligent recognition, automatic switching
-    - If the language is missing or the built-in language is inaccurate, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to register and add it yourself, or submit an issue
-    - The original configuration option `locale` is retained, but manual configuration is no longer recommended
-- **timeago**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
-    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), register and add it yourself
+- <mark>tooltip</mark>: built-in languages: `en zh zh_TW es fr de ar ja ko ru nl pt`, **no need to manually configure**, intelligent recognition, automatic switching
+    - If there is any missing language or inaccurate built-in language, you can refer to [Part 3](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) in `user.config.js` to add it by registering yourself, or submit PR for built-in
+    - The original configuration item `locale` has been retained, but manual configuration is no longer recommended
+- <mark>timeago</mark>: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if need to load other languages, you can configure it as below (choose one):
+    - In `user.config.js`, refer to [Part 2](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js), add it by registering yourself
     - In `mkdocs.yml`, configure the full version of `timeago.full.min.js` to reload all languages at once
         ```yaml
         extra_javascript:
-        - assets/document_dates/core/timeago.full.min.js
+          - assets/document_dates/core/timeago.full.min.js
         ```
 
 ## Template Variables
@@ -178,12 +183,22 @@ You can access the meta-info of a document in a template using the following var
 - page.meta.document_dates_created
 - page.meta.document_dates_modified
 - page.meta.document_dates_authors
+- config.extra.recently_updated_docs
 
 Usage examples:
 
 - **Example 1**: Set the correct `lastmod` for your site's `sitemap.xml` so that search engines can better handle SEO and thus increase your site's exposure (download [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/sitemap.xml) and override this path: `docs/overrides/sitemap.xml`)
 - **Example 2**: Using the template to re-customize the plugin, you have full control over the rendering logic and the plugin is only responsible for providing the data (download [source-file.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/source-file.html) and override this path: `docs/overrides/partials/source-file.html`)
 
+## Recently updated module
+
+You can get the recently updated document data use `config.extra.recently_updated_docs` in any template, then customize the rendering logic yourself, or use the preset template examples directly:
+
+- **Example 1**: Add the recently updated module to the navigation of the sidebar (download [nav.html](https://github.com/jaywhj/mkdocs-document-dates/blob/main/templates/overrides/partials/nav.html) and override this path: `docs/overrides/partials/nav.html`)
+- **Example 2**: Add this feature anywhere in any md document, you can install the plugin [mkdocs-recently-updated-docs](https://github.com/jaywhj/mkdocs-recently-updated-docs), which is also based on the data capabilities provided by this plugin and provides more template examples, making it easier to use
+
+![recently-updated](recently-updated.png)
+
 ## Other Tips
 
 - In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
@@ -216,10 +231,10 @@ A dispensable, insignificant little plug-in, friends who have time can take a lo
         - Solution: Reduce the number of I/Os + Use caching + Replace less efficient system functions
 - **Improve**:
     - Since it's a newly developed plugin, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity, personalization, intelligence**
-        - **Ease of use**: there are no complex configurations, only 2-3 commonly used configuration options, in addition, a template is provided for personalized configurations
+        - **Ease of use**: no complex configuration, only 2-3 commonly used configuration items, in addition to providing the reference template for personalized configurations
         - **Simplicity**: no unnecessary configuration, no Git dependencies, no CI/CD configuration dependencies, no other package dependencies
         - **Personalization**: fully customizable and full control over the rendering logic, the plugin is only responsible for providing the data
-        - **Intelligence**: intelligently parse document time, author, avatar, intelligent recognition of user language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
+        - **Intelligence**: Intelligent parsing of document time, author, avatar, intelligent recognition of the user's language and automatic adaptation, in addition, there are auto-install Git Hooks, auto-cache, auto-commit
         - **Compatibility**: works well on older operating systems and browsers, such as WIN7, MacOS 10.11, iOS 12, Chrome 63.0.3239
 - **The Last Secret**:
     - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/mkdocs_document_dates.egg-info/SOURCES.txt

@@ -23,7 +23,6 @@ mkdocs_document_dates/static/core/timeago.full.min.js
 mkdocs_document_dates/static/core/timeago.min.js
 mkdocs_document_dates/static/core/utils.js
 mkdocs_document_dates/static/fonts/material-icons.css
-mkdocs_document_dates/static/fonts/materialicons.ttf
 mkdocs_document_dates/static/fonts/materialicons.woff2
 mkdocs_document_dates/static/tippy/backdrop.css
 mkdocs_document_dates/static/tippy/light.css

{mkdocs_document_dates-3.3.4 → mkdocs_document_dates-3.4}/setup.py

@@ -22,13 +22,8 @@ class CustomInstallCommand(install):
         atexit.register(trigger_hook_install)
         install.run(self)
 
-try:
-    with open("README.md", "r", encoding="utf-8") as fh:
-        long_description = fh.read()
-except FileNotFoundError:
-    long_description = "A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents"
 
-VERSION = '3.3.4'
+VERSION = '3.4'
 
 setup(
     name="mkdocs-document-dates",
@@ -37,7 +32,7 @@ setup(
     author_email="aaronwqt@gmail.com",
     license="MIT",
     description="A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents",
-    long_description=long_description,
+    long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/jaywhj/mkdocs-document-dates",
     packages=find_packages(),