mkdocs-document-dates 3.4.8__tar.gz → 3.5__tar.gz

{mkdocs_document_dates-3.4.8/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.8
+Version: 3.5
 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
@@ -30,16 +30,16 @@ English | [简体中文](README_zh.md)
 
 <br />
 
-A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+A new generation MkDocs plugin for displaying exact **creation date, last updated date, authors, email** of documents
 
 ![render](render.gif)
 
 ## Features
 
-- [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
-- [x] Support list display of recently updated documents (in descending order of update time)
-- [x] Support for manually specifying time and author in `Front Matter`
-- [x] Support for multiple time formats (date, datetime, timeago)
+- [x] Always displays **exact** meta information of the document and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update date)
+- [x] Support for manually specifying date and author in `Front Matter`
+- [x] Support for multiple date formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
@@ -51,7 +51,7 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 | Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
-| git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
+| git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
 ## Installation
@@ -74,28 +74,30 @@ Or, full configuration:
 ```yaml
 plugins:
   - document-dates:
-      position: top            # Display position: top(after title) bottom(end of document)
+      position: top            # Display position: top(after title) bottom(end of document), default: top
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
-      show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
+      show_created: true       # Show creation date: true false, default: true
+      show_updated: true       # Show last updated date: true false, default: true
+      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
 ```
 
 ## Customization Settings
 
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
-- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
-- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
-- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
+- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): Introduces the mechanism for obtaining document dates and methods for personalized customization, you can manually specify the creation date and last updated date for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, you can manually specify the author information for each document, such as name, link, avatar, email, etc.
+- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 
 See the documentation for details: https://jaywhj.netlify.app/document-dates-en

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/README.md

@@ -4,16 +4,16 @@ English | [简体中文](README_zh.md)
 
 <br />
 
-A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+A new generation MkDocs plugin for displaying exact **creation date, last updated date, authors, email** of documents
 
 ![render](render.gif)
 
 ## Features
 
-- [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
-- [x] Support list display of recently updated documents (in descending order of update time)
-- [x] Support for manually specifying time and author in `Front Matter`
-- [x] Support for multiple time formats (date, datetime, timeago)
+- [x] Always displays **exact** meta information of the document and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update date)
+- [x] Support for manually specifying date and author in `Front Matter`
+- [x] Support for multiple date formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
@@ -25,7 +25,7 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 | Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
-| git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
+| git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
 ## Installation
@@ -48,28 +48,30 @@ Or, full configuration:
 ```yaml
 plugins:
   - document-dates:
-      position: top            # Display position: top(after title) bottom(end of document)
+      position: top            # Display position: top(after title) bottom(end of document), default: top
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
-      show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
+      show_created: true       # Show creation date: true false, default: true
+      show_updated: true       # Show last updated date: true false, default: true
+      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
 ```
 
 ## Customization Settings
 
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
-- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
-- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
-- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
+- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): Introduces the mechanism for obtaining document dates and methods for personalized customization, you can manually specify the creation date and last updated date for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, you can manually specify the author information for each document, such as name, link, avatar, email, etc.
+- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 
 See the documentation for details: https://jaywhj.netlify.app/document-dates-en

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/plugin.py

@@ -10,7 +10,7 @@ from mkdocs.config import config_options
 from mkdocs.structure.pages import Page
 from mkdocs.utils import get_relative_url
 from urllib.parse import urlparse
-from .utils import get_file_creation_time, load_git_cache, read_jsonl_cache,is_excluded, get_recently_updated_files
+from .utils import get_file_creation_time, load_git_metadata, load_git_last_updated_date, read_jsonl_cache,is_excluded, get_recently_updated_files
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
@@ -34,7 +34,9 @@ class DocumentDatesPlugin(BasePlugin):
         ('position', config_options.Type(str, default='top')),
         ('exclude', config_options.Type(list, default=[])),
         ('created_field_names', config_options.Type(list, default=['created', 'date'])),
-        ('modified_field_names', config_options.Type(list, default=['modified', 'updated'])),
+        ('updated_field_names', config_options.Type(list, default=['updated', 'modified'])),
+        ('show_created', config_options.Type(bool, default=True)),
+        ('show_updated', config_options.Type(bool, default=True)),
         ('show_author', config_options.Choice((True, False, 'text'), default=True)),
         ('recently-updated', config_options.Type((dict, bool), default={}))
     )
@@ -52,21 +54,20 @@ class DocumentDatesPlugin(BasePlugin):
         docs_dir_path = Path(config['docs_dir'])
 
         # 加载 author 配置
-        if self.config['show_author']:
-            self._extract_github_username(config.get('repo_url'))
-            authors_file = docs_dir_path / 'authors.yml'
-            if not authors_file.exists():
-                try:
-                    blog_config = config['plugins']['material/blog'].config
-                    authors_file_resolved = blog_config.authors_file.format(blog=blog_config.blog_dir)
-                    authors_file = docs_dir_path / authors_file_resolved
-                except Exception:
-                    pass
-            self._load_authors_from_yaml(authors_file)
-
-        # 加载 git 缓存
-        self.dates_cache = load_git_cache(docs_dir_path)
-        # 覆盖 jsonl 文件缓存
+        self._extract_github_username(config.get('repo_url'))
+        authors_file = docs_dir_path / 'authors.yml'
+        if not authors_file.exists():
+            try:
+                blog_config = config['plugins']['material/blog'].config
+                authors_file_resolved = blog_config.authors_file.format(blog=blog_config.blog_dir)
+                authors_file = docs_dir_path / authors_file_resolved
+            except Exception:
+                pass
+        self._load_authors_from_yaml(authors_file)
+
+        # 加载文档元数据
+        self.dates_cache = load_git_metadata(docs_dir_path)
+        # 覆盖 jsonl 缓存
         jsonl_cache_file = docs_dir_path / '.dates_cache.jsonl'
         if jsonl_cache_file.exists():
             jsonl_cache = read_jsonl_cache(jsonl_cache_file)
@@ -74,6 +75,10 @@ class DocumentDatesPlugin(BasePlugin):
                 if filename in self.dates_cache:
                     self.dates_cache[filename].update(new_info)
 
+        # 加载文档最近更新时间
+        self.last_updated_dates = load_git_last_updated_date(docs_dir_path)
+
+
         # 复制配置文件到用户目录（如果不存在）
         dest_dir = docs_dir_path / 'assets' / 'document_dates'
         dest_dir.mkdir(parents=True, exist_ok=True)
@@ -136,35 +141,6 @@ class DocumentDatesPlugin(BasePlugin):
 
         return config
 
-    def on_nav(self, nav, config, files):
-        recently_updated_config = self.config.get('recently-updated')
-        if recently_updated_config:
-            self.recent_enable = True
-
-        # 兼容 true 配置
-        if recently_updated_config is True:
-            recently_updated_config = {}
-
-        # 获取配置
-        exclude_list = recently_updated_config.get('exclude', [])
-        limit = recently_updated_config.get('limit', 10)
-        template_path = recently_updated_config.get('template')
-
-        # 获取最近更新日期和最近更新的文档数据
-        docs_dir = Path(config['docs_dir'])
-        self.last_updated_dates, recently_updated_docs = get_recently_updated_files(docs_dir, files, exclude_list, limit, self.recent_enable)
-
-        # 将数据注入到 config['extra'] 中供全局访问
-        if 'extra' not in config:
-            config['extra'] = {}
-        config['extra']['recently_updated_docs'] = recently_updated_docs
-
-        # 渲染HTML
-        if self.recent_enable:
-            self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_updated_docs)
-
-        return nav
-
     def on_page_markdown(self, markdown, page: Page, config, files):
         # 获取相对路径，src_uri 总是以"/"分隔
         rel_path = getattr(page.file, 'src_uri', page.file.src_path)
@@ -174,38 +150,69 @@ class DocumentDatesPlugin(BasePlugin):
         
         # 获取时间信息
         created = self._find_meta_date(page.meta, self.config['created_field_names'])
-        modified = self._find_meta_date(page.meta, self.config['modified_field_names'])
+        updated = self._find_meta_date(page.meta, self.config['updated_field_names'])
         if not created:
             created = self._get_file_creation_time(file_path, rel_path)
-        if not modified:
-            modified = self._get_file_modification_time(file_path, rel_path)
+        if not updated:
+            updated = self._get_file_modification_time(file_path, rel_path)
         
         # 获取作者信息
         authors = self._get_author_info(rel_path, page, config)
-        if len(authors) == 1:
+        if authors and len(authors) == 1:
             a = authors[0]
             if not a.avatar and self.github_username:
                 a.avatar = f"https://avatars.githubusercontent.com/{self.github_username}"
         
         # 在排除前暴露 meta 信息给前端使用
         page.meta['document_dates_created'] = created.isoformat()
-        page.meta['document_dates_modified'] = modified.isoformat()
+        page.meta['document_dates_updated'] = updated.isoformat()
         page.meta['document_dates_authors'] = authors
         
-        # 占位符替换
-        if self.recent_enable and '\n<!-- RECENTLY_UPDATED_DOCS -->' in markdown:
-            markdown = markdown.replace('\n<!-- RECENTLY_UPDATED_DOCS -->', self.recent_docs_html or '')
-        
         # 检查是否需要排除
         if is_excluded(rel_path, self.config['exclude']):
             return markdown
         
         # 生成日期和作者信息 HTML
-        info_html = self._generate_html_info(created, modified, authors)
+        info_html = self._generate_html_info(created, updated, authors)
         
         # 将信息写入 markdown
         return self._insert_date_info(markdown, info_html)
 
+    def on_env(self, env, config, files):
+        recently_updated_config = self.config.get('recently-updated')
+        if recently_updated_config:
+            self.recent_enable = True
+
+        # 兼容 true 配置
+        if recently_updated_config is True:
+            recently_updated_config = {}
+
+        # 获取配置
+        exclude_list = recently_updated_config.get('exclude', [])
+        limit = recently_updated_config.get('limit', 10)
+        template_path = recently_updated_config.get('template')
+
+        # 获取最近更新的文档数据
+        recently_updated_docs = get_recently_updated_files(self.last_updated_dates, files, exclude_list, limit, self.recent_enable)
+
+        # 将数据注入到 config['extra'] 中供全局访问
+        if 'extra' not in config:
+            config['extra'] = {}
+        config['extra']['recently_updated_docs'] = recently_updated_docs
+
+        # 渲染HTML
+        if self.recent_enable:
+            docs_dir = Path(config['docs_dir'])
+            self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_updated_docs)
+
+        return env
+
+    def on_post_page(self, output, page, config):
+        if self.recent_enable and '\n<!-- RECENTLY_UPDATED_DOCS -->' in output:
+            output = output.replace('\n<!-- RECENTLY_UPDATED_DOCS -->', self.recent_docs_html or '')
+
+        return output
+
     def on_post_build(self, config):
         site_dest_dir = Path(config['site_dir']) / 'assets' / 'document_dates'
         for dir_name in ['tippy', 'core', 'fonts']:
@@ -258,8 +265,8 @@ class DocumentDatesPlugin(BasePlugin):
 
         # 加载模板
         env = Environment(
-            loader=FileSystemLoader(str(template_dir)),
-            autoescape=select_autoescape(["html", "xml"])
+            loader = FileSystemLoader(str(template_dir)),
+            autoescape = select_autoescape(["html", "xml"])
         )
         template = env.get_template(template_file)
 
@@ -295,8 +302,6 @@ class DocumentDatesPlugin(BasePlugin):
 
 
     def _get_author_info(self, rel_path, page, config):
-        if not self.config['show_author']:
-            return None
         # 1. meta author
         authors = self._process_meta_author(page.meta, page.url)
         if authors:
@@ -373,7 +378,7 @@ class DocumentDatesPlugin(BasePlugin):
             return date.strftime(f"{self.config['date_format']} {self.config['time_format']}")
         return date.strftime(self.config['date_format'])
 
-    def _generate_html_info(self, created: datetime, modified: datetime, authors=None):
+    def _generate_html_info(self, created: datetime, updated: datetime, authors=None):
         try:
             # 构建基本的日期信息 HTML
             html_parts = []
@@ -390,8 +395,10 @@ class DocumentDatesPlugin(BasePlugin):
                     f"{self._get_formatted_date(time_obj)}</time></span>"
                 )
 
-            html_parts.append(build_time_icon(created, 'doc_created'))
-            html_parts.append(build_time_icon(modified, 'doc_modified'))
+            if self.config['show_created']:
+                html_parts.append(build_time_icon(created, 'doc_created'))
+            if self.config['show_updated']:
+                html_parts.append(build_time_icon(updated, 'doc_updated'))
 
             # 添加作者信息
             if self.config['show_author'] and authors:
@@ -405,12 +412,13 @@ class DocumentDatesPlugin(BasePlugin):
                 if self.config['show_author'] == 'text':
                     # 显示文本模式
                     tooltip_text = ',&nbsp;'.join(get_author_tooltip(author) for author in authors)
-                    author_text = ', '.join(author.name for author in authors)
+                    # author_text = ', '.join(author.name for author in authors)
                     icon = 'doc_author' if len(authors) == 1 else 'doc_authors'
                     html_parts.append(
                         f"<span data-tippy-content data-tippy-raw='{tooltip_text}'>"
                         f"<span class='material-icons' data-icon='{icon}'></span>"
-                        f"{author_text}"
+                        f"{tooltip_text}"
+                        # f"{author_text}"
                         f"</span>"
                     )
                 else:

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/config/user.config.css

@@ -14,14 +14,15 @@
     Google Fonts Icons (2500+): https://fonts.google.com/icons
 
     doc_created:  add_circle, add_circle, note_add, more_time
-    doc_modified: update, check_circle, task, refresh
+    doc_updated:  update, check_circle, task, refresh
     doc_author:   person, account_circle
     doc_authors:  group, groups */
+
 /* 
 .document-dates-plugin .material-icons[data-icon="doc_created"]::before {
     content: "more_time";
 }
-.document-dates-plugin .material-icons[data-icon="doc_modified"]::before {
+.document-dates-plugin .material-icons[data-icon="doc_updated"]::before {
     content: "refresh";
 }
 .document-dates-plugin .material-icons[data-icon="doc_author"]::before {
@@ -36,6 +37,7 @@
 /* 2. Plug-in wrapper styles
     including divider line, margin, padding, and the hiding of this plugin, etc
     */
+
 /* Remove the divider line: */
 /* 
 .document-dates-plugin-wrapper.document-dates-top,

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/config/user.config.js

@@ -70,7 +70,7 @@ Part 3:
 // Way 1: User-defined one language
 TooltipLanguage.register('en', {
     created_time: "Custom Created",
-    modified_time: "Custom Last Update",
+    updated_time: "Custom Last Update",
     author: "Custom Author",
     authors: "Custom Authors"
 });
@@ -79,13 +79,13 @@ TooltipLanguage.register('en', {
 const userLanguages = {
     en: {
         created_time: "Created",
-        modified_time: "Last Update",
+        updated_time: "Last Update",
         author: "Author",
         authors: "Authors"
     },
     zh: {
         created_time: "创建时间",
-        modified_time: "最后更新",
+        updated_time: "最后更新",
         author: "作者",
         authors: "作者"
     }

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/core/core.css

@@ -35,13 +35,13 @@
     Google Fonts Icons (2500+): https://fonts.google.com/icons
 
     doc_created:  add_circle, add_circle, note_add, more_time
-    doc_modified: update, check_circle, task, refresh
+    doc_updated:  update, check_circle, task, refresh
     doc_author:   person, account_circle
     doc_authors:  group, groups */
 .document-dates-plugin .material-icons[data-icon="doc_created"]::before {
     content: "more_time";
 }
-.document-dates-plugin .material-icons[data-icon="doc_modified"]::before {
+.document-dates-plugin .material-icons[data-icon="doc_updated"]::before {
     content: "refresh";
 }
 .document-dates-plugin .material-icons[data-icon="doc_author"]::before {
@@ -59,7 +59,7 @@
 .document-dates-plugin-wrapper.document-dates-top,
 .document-dates-plugin-wrapper.document-dates-bottom {
     margin: 1rem 0;
-    border-bottom: 1px solid rgba(142, 142, 142, 0.15);
+    border-bottom: 1px solid rgba(142, 142, 142, 0.1);
 }
 .md-main .document-dates-plugin-wrapper.document-dates-top {
     margin: -1rem 0 1rem 0;

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/core/core.js

@@ -50,7 +50,7 @@ function generateAvatar() {
 // 图标键映射表
 const iconKeyMap = {
     doc_created: 'created_time',
-    doc_modified: 'modified_time',
+    doc_updated: 'updated_time',
     doc_author: 'author',
     doc_authors: 'authors'
 };

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/core/default.config.js

@@ -86,73 +86,73 @@ window.TooltipLanguage = (function () {
     const defaultLanguages = {
         ar: {
             created_time: "تاريخ الإنشاء",
-            modified_time: "تاريخ التعديل",
+            updated_time: "تاريخ التعديل",
             author: "المؤلف",
             authors: "المؤلفون"
         },
         de: {
             created_time: "Erstellungszeit",
-            modified_time: "Änderungszeit",
+            updated_time: "Änderungszeit",
             author: "Autor",
             authors: "Autoren"
         },
         en: {
             created_time: "Created",
-            modified_time: "Last Update",
+            updated_time: "Last Update",
             author: "Author",
             authors: "Authors"
         },
         es: {
             created_time: "Fecha de creación",
-            modified_time: "Fecha de modificación",
+            updated_time: "Fecha de modificación",
             author: "Autor",
             authors: "Autores"
         },
         fr: {
             created_time: "Date de création",
-            modified_time: "Date de modification",
+            updated_time: "Date de modification",
             author: "Auteur",
             authors: "Auteurs"
         },
         ja: {
             created_time: "作成日時",
-            modified_time: "更新日時",
+            updated_time: "更新日時",
             author: "著者",
             authors: "著者"
         },
         ko: {
             created_time: "작성일",
-            modified_time: "수정일",
+            updated_time: "수정일",
             author: "작성자",
             authors: "작성자"
         },
         nl: {
             created_time: "Gecreëerd",
-            modified_time: "Laatst geüpdatet",
+            updated_time: "Laatst geüpdatet",
             author: "Auteur",
             authors: "Auteurs"            
         },
         pt: {
             created_time: "Criado em",
-            modified_time: "Última atualização",
+            updated_time: "Última atualização",
             author: "Autor",
             authors: "Autores"
         },
         ru: {
             created_time: "Дата создания",
-            modified_time: "Дата изменения",
+            updated_time: "Дата изменения",
             author: "Автор",
             authors: "Авторы"
         },
         zh: {
             created_time: "创建时间",
-            modified_time: "最后更新",
+            updated_time: "最后更新",
             author: "作者",
             authors: "作者"
         },
         zh_TW: {
             created_time: "建立時間",
-            modified_time: "修改時間",
+            updated_time: "修改時間",
             author: "作者",
             authors: "作者"
         }

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/static/templates/recently_updated.html

@@ -6,7 +6,7 @@
     margin: 0;
     padding: 16px;
     border: 1px solid rgba(142, 142, 142, 0.15);
-    border-radius: 4px;
+    border-radius: 8px;
     font-family: system-ui, sans-serif;
 }
 .recently-updated-item {
@@ -14,11 +14,11 @@
     align-items: center;
 }
 .recently-updated-item span {
-    font-size: 0.85em;
+    font-size: 0.84em;
     color: rgba(142, 142, 142, 0.5);
-    margin-right: 5px;
+    margin-right: 4px;
     flex-shrink: 0;
-    width: 95px;
+    width: 90px;
 }
 .recently-updated-item a {
     overflow: hidden;

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/mkdocs_document_dates/utils.py

@@ -25,6 +25,23 @@ def is_excluded(path, exclude_list):
                 return True
     return False
 
+def get_file_creation_time(file_path):
+    try:
+        stat = os.stat(file_path)
+        system = platform.system().lower()
+        if system.startswith('win'):  # Windows
+            return datetime.fromtimestamp(stat.st_ctime)
+        elif system == 'darwin':  # macOS
+            try:
+                return datetime.fromtimestamp(stat.st_birthtime)
+            except AttributeError:
+                return datetime.fromtimestamp(stat.st_ctime)
+        else:  # Linux, 没有创建时间，使用修改时间
+            return datetime.fromtimestamp(stat.st_mtime)
+    except (OSError, ValueError) as e:
+        logger.error(f"Failed to get file creation time for {file_path}: {e}")
+        return datetime.now()
+
 def get_git_first_commit_time(file_path):
     try:
         # git log --reverse --format="%aI" -- {file_path} | head -n 1
@@ -37,7 +54,7 @@ def get_git_first_commit_time(file_path):
         logger.info(f"Error getting git first commit time for {file_path}: {e}")
     return None
 
-def load_git_cache(docs_dir_path: Path):
+def load_git_metadata(docs_dir_path: Path):
     dates_cache = {}
     try:
         git_root = Path(subprocess.check_output(
@@ -82,27 +99,9 @@ def load_git_cache(docs_dir_path: Path):
         logger.info(f"Error getting git info in {docs_dir_path}: {e}")
     return dates_cache
 
-def get_file_creation_time(file_path):
-    try:
-        stat = os.stat(file_path)
-        system = platform.system().lower()
-        if system.startswith('win'):  # Windows
-            return datetime.fromtimestamp(stat.st_ctime)
-        elif system == 'darwin':  # macOS
-            try:
-                return datetime.fromtimestamp(stat.st_birthtime)
-            except AttributeError:
-                return datetime.fromtimestamp(stat.st_ctime)
-        else:  # Linux, 没有创建时间，使用修改时间
-            return datetime.fromtimestamp(stat.st_mtime)
-    except (OSError, ValueError) as e:
-        logger.error(f"Failed to get file creation time for {file_path}: {e}")
-        return datetime.now()
-
-def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False):
+def load_git_last_updated_date(docs_dir_path: Path):
     doc_mtime_map = {}
     try:
-        # 1. 获取 git 信息，只记录已跟踪的文件最近一次的提交信息
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
             cwd=docs_dir_path, encoding='utf-8'
@@ -116,6 +115,7 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
                 ["git", "ls-files", "*.md"],
                 cwd=docs_dir_path, capture_output=True, encoding='utf-8'
             )
+            # 只记录已跟踪的文件（还有已删除、重命名、不再跟踪）
             tracked_files = set(result.stdout.splitlines()) if result.stdout else set()
 
             ts = None
@@ -131,11 +131,15 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
     except Exception as e:
         logger.info(f"Error getting git tracked files in {docs_dir_path}: {e}")
 
-    # 2. 构建所有文档的元数据
+    return doc_mtime_map
+
+def get_recently_updated_files(existing_map: dict, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False):
     recently_updated_results = []
     if recent_enable:
         files_meta = []
         for file in files:
+            if file.inclusion.is_excluded():
+                continue
             if not file.src_path.endswith('.md'):
                 continue
             rel_path = getattr(file, 'src_uri', file.src_path)
@@ -144,23 +148,18 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
             if is_excluded(rel_path, exclude_list):
                 continue
 
-            # 获取文档标题和 URL
-            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，如果不存在则 fallback 到文件系统 mtime
+            mtime = existing_map.get(rel_path, os.path.getmtime(file.abs_src_path))
 
-            # 获取 git 记录的 mtime，没有则 fallback 到文件系统 mtime
-            mtime = doc_mtime_map.get(rel_path, os.path.getmtime(file.abs_src_path))
+            # 获取文档标题和 URL
+            title = file.page.title if file.page and file.page.title else file.name
+            url = file.page.url if file.page and file.page.url else file.url
 
             # 存储信息
             files_meta.append((mtime, rel_path, title, url))
-            doc_mtime_map[rel_path] = mtime
+            # existing_map[rel_path] = mtime
 
-        # 3. 构建最近更新列表
+        # 构建最近更新列表
         if files_meta:
             # heapq 取 top limit
             top_results = heapq.nlargest(limit, files_meta, key=lambda x: x[0])
@@ -169,7 +168,7 @@ def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list:
                 for mtime, *rest in top_results
             ]
 
-    return doc_mtime_map, recently_updated_results
+    return recently_updated_results
 
 def read_jsonl_cache(jsonl_file: Path):
     dates_cache = {}

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.8
+Version: 3.5
 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
@@ -30,16 +30,16 @@ English | [简体中文](README_zh.md)
 
 <br />
 
-A new generation MkDocs plugin for displaying exact **creation time, last update time, authors, email** of documents
+A new generation MkDocs plugin for displaying exact **creation date, last updated date, authors, email** of documents
 
 ![render](render.gif)
 
 ## Features
 
-- [x] Always displays **exact** meta information of the document and works in any environment (no Git, Git environments, Docker containers, all CI/CD build systems, etc.)
-- [x] Support list display of recently updated documents (in descending order of update time)
-- [x] Support for manually specifying time and author in `Front Matter`
-- [x] Support for multiple time formats (date, datetime, timeago)
+- [x] Always displays **exact** meta information of the document and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.)
+- [x] Support list display of recently updated documents (in descending order of update date)
+- [x] Support for manually specifying date and author in `Front Matter`
+- [x] Support for multiple date formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Support for manually configuring author's name, link, avatar, email, etc.
 - [x] Flexible display position (top or bottom)
@@ -51,7 +51,7 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 | Build Speed Comparison:     | 100 md: | 1000 md: | Time Complexity: |
 | --------------------------- | :-----: | :------: | :----------: |
-| git-revision-date-localized |  > 3 s   |  > 30 s   |    O(n)    |
+| git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
 ## Installation
@@ -74,28 +74,30 @@ Or, full configuration:
 ```yaml
 plugins:
   - document-dates:
-      position: top            # Display position: top(after title) bottom(end of document)
+      position: top            # Display position: top(after title) bottom(end of document), default: top
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
       date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
       time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
-      show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
+      show_created: true       # Show creation date: true false, default: true
+      show_updated: true       # Show last updated date: true false, default: true
+      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
 ```
 
 ## Customization Settings
 
 In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:
 
-- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): You can manually specify the creation time and last update time for each document
-- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): You can manually specify the author information for each document, such as name, link, avatar, email, etc.
-- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author
-- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): Such as icons, themes, colors, fonts, animations, dividing line, etc.
+- [Specify Datetime](https://jaywhj.netlify.app/document-dates-en#Specify-Datetime): Introduces the mechanism for obtaining document dates and methods for personalized customization, you can manually specify the creation date and last updated date for each document
+- [Specify Author](https://jaywhj.netlify.app/document-dates-en#Specify-Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, you can manually specify the author information for each document, such as name, link, avatar, email, etc.
+- [Specify Avatar](https://jaywhj.netlify.app/document-dates-en#Specify-Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Set Plugin Style](https://jaywhj.netlify.app/document-dates-en#Set-Plugin-Style): You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
 - [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [Use Template Variables](https://jaywhj.netlify.app/document-dates-en#Use-Template-Variables): Can be used to optimize `sitemap.xml` for site SEO, can be used to re-customize plug-ins, etc.
-- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update time)
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it in Docker
+- [Add Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#Add-Recently-Updated-Module): Enable list of recently updated documents (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
 - [Development Stories](https://jaywhj.netlify.app/document-dates-en#Development-Stories): Describes the origin of the plug-in, the difficulties and solutions encountered in development, and the principles and directions of product design
 
 See the documentation for details: https://jaywhj.netlify.app/document-dates-en

{mkdocs_document_dates-3.4.8 → mkdocs_document_dates-3.5}/setup.py

@@ -23,7 +23,7 @@ class CustomInstallCommand(install):
         install.run(self)
 
 
-VERSION = '3.4.8'
+VERSION = '3.5'
 
 setup(
     name="mkdocs-document-dates",