mkdocs-document-dates 3.4.1__tar.gz → 3.4.5__tar.gz

{mkdocs_document_dates-3.4.1/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.1
+Version: 3.4.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
@@ -36,14 +36,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 ## Features
 
-- [x] Always display **exact** meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc.)
+- [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 for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Supports display of recently updated documents in an overall list
+- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -53,7 +53,6 @@ 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)    |
 
-
 ## Installation
 
 ```bash
@@ -77,9 +76,9 @@ plugins:
       position: top            # Display position: top(after title) bottom(end of document)
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
-        - temp.md              # Exclude specific file
-        - 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
+        - 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)
       recently-updated: true   # Whether to turn on recently updated data, default: false
@@ -96,7 +95,7 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 - [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
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it 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.1 → mkdocs_document_dates-3.4.5}/README.md

@@ -10,14 +10,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 ## Features
 
-- [x] Always display **exact** meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc.)
+- [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 for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Supports display of recently updated documents in an overall list
+- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -27,7 +27,6 @@ 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)    |
 
-
 ## Installation
 
 ```bash
@@ -51,9 +50,9 @@ plugins:
       position: top            # Display position: top(after title) bottom(end of document)
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
-        - temp.md              # Exclude specific file
-        - 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
+        - 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)
       recently-updated: true   # Whether to turn on recently updated data, default: false
@@ -70,7 +69,7 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 - [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
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it 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.1 → mkdocs_document_dates-3.4.5}/mkdocs_document_dates/cache_manager.py

@@ -11,7 +11,7 @@ def find_mkdocs_projects():
     try:
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
-            text=True, encoding='utf-8'
+            encoding='utf-8'
         ).strip())
 
         # 遍历 git_root 及子目录, 寻找 mkdocs.yml 文件
@@ -65,7 +65,7 @@ def update_cache():
 
             # 获取docs目录下已跟踪(tracked)的markdown文件
             cmd = ["git", "ls-files", "*.md"]
-            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True)
+            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, encoding='utf-8')
             tracked_files = result.stdout.splitlines() if result.stdout else []
 
             if not tracked_files:

{mkdocs_document_dates-3.4.1 → mkdocs_document_dates-3.4.5}/mkdocs_document_dates/hooks_installer.py

@@ -12,13 +12,20 @@ def get_config_dir():
     if platform.system().lower().startswith('win'):
         return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
     else:
-        return Path.home() / '.config'
+        # 优先级：XDG_CONFIG_HOME > $HOME/.config > cwd/.config
+        xdg_config = os.getenv('XDG_CONFIG_HOME')
+        if xdg_config:
+            return Path(xdg_config)
+        home = os.getenv('HOME')
+        if home:
+            return Path(home) / '.config'
+        return Path.cwd() / '.config'
 
 def check_python_version(interpreter):
     try:
         result = subprocess.run(
             [interpreter, "-c", "import sys; print(sys.version_info >= (3, 7))"],
-            capture_output=True, text=True)
+            capture_output=True, encoding='utf-8')
         if result.returncode == 0 and result.stdout.strip().lower() == 'true':
             return True
         else:
@@ -44,7 +51,11 @@ def setup_hooks_directory():
         os.chmod(config_dir, 0o755)
         return config_dir
     except PermissionError:
-        logger.error(f"No permission to create directory: {config_dir}")
+        logger.error(
+            f"No permission to create directory: {config_dir}\n"
+            "If running inside Docker, please set environment variable HOME=/docs "
+            "or XDG_CONFIG_HOME to a writable path."
+        )
     except Exception as e:
         logger.error(f"Failed to create directory {config_dir}: {str(e)}")
     return None

{mkdocs_document_dates-3.4.1 → mkdocs_document_dates-3.4.5}/mkdocs_document_dates/plugin.py

@@ -9,7 +9,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,is_excluded, get_recently_modified_files
+from .utils import get_file_creation_time, load_git_cache, 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
@@ -41,8 +41,8 @@ class DocumentDatesPlugin(BasePlugin):
         ('time_format', config_options.Type(str, default='%H:%M:%S')),
         ('position', config_options.Type(str, default='top')),
         ('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'])),
+        ('created_field_names', config_options.Type(list, default=['created', 'date'])),
+        ('modified_field_names', config_options.Type(list, default=['modified', 'updated'])),
         ('show_author', config_options.Choice((True, False, 'text'), default=True)),
         ('recently-updated', config_options.Type((dict, bool), default={}))
     )
@@ -50,6 +50,7 @@ class DocumentDatesPlugin(BasePlugin):
     def __init__(self):
         super().__init__()
         self.dates_cache = {}
+        self.last_updated_dates = {}
         self.authors_yml = {}
         self.github_username = None
         self.recent_docs_html = None
@@ -145,10 +146,9 @@ class DocumentDatesPlugin(BasePlugin):
 
     def on_nav(self, nav, config, files):
         recently_updated_config = self.config.get('recently-updated')
-        if not recently_updated_config:
-            return nav
+        if recently_updated_config:
+            self.recent_enable = True
 
-        self.recent_enable = True
         # 兼容 true 配置
         if recently_updated_config is True:
             recently_updated_config = {}
@@ -156,19 +156,20 @@ class DocumentDatesPlugin(BasePlugin):
         # 获取配置
         exclude_list = recently_updated_config.get('exclude', [])
         limit = recently_updated_config.get('limit', 10)
-        template_path = recently_updated_config.get("template")
+        template_path = recently_updated_config.get('template')
 
-        # 获取 docs 目录下最近更新的文档
-        recently_modified_files = get_recently_modified_files(files, exclude_list, limit)
+        # 获取最近更新日期和最近更新的文档数据
+        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_modified_files
+        config['extra']['recently_updated_docs'] = recently_updated_docs
 
         # 渲染HTML
-        docs_dir = Path(config['docs_dir'])
-        self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_modified_files)
+        if self.recent_enable:
+            self.recent_docs_html = self._render_recently_updated_html(docs_dir, template_path, recently_updated_docs)
 
         return nav
 
@@ -210,7 +211,7 @@ class DocumentDatesPlugin(BasePlugin):
         if not created:
             created = self._get_file_creation_time(file_path, rel_path)
         if not modified:
-            modified = self._get_file_modification_time(file_path)
+            modified = self._get_file_modification_time(file_path, rel_path)
         
         # 获取作者信息
         authors = self._get_author_info(rel_path, page, config)
@@ -221,8 +222,8 @@ class DocumentDatesPlugin(BasePlugin):
         page.meta['document_dates_authors'] = authors
         
         # 占位符替换
-        if self.recent_enable and '<!-- RECENTLY_UPDATED_DOCS -->' in markdown:
-            markdown = markdown.replace('<!-- RECENTLY_UPDATED_DOCS -->', self.recent_docs_html or '')
+        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']):
@@ -293,7 +294,10 @@ class DocumentDatesPlugin(BasePlugin):
         # 从文件系统获取
         return get_file_creation_time(file_path).astimezone()
 
-    def _get_file_modification_time(self, file_path):
+    def _get_file_modification_time(self, file_path, rel_path):
+        # 优先从缓存中读取
+        if rel_path in self.last_updated_dates:
+            return datetime.fromtimestamp(self.last_updated_dates[rel_path]).astimezone()
         # 从文件系统获取最后修改时间
         stat = os.stat(file_path)
         return datetime.fromtimestamp(stat.st_mtime).astimezone()

{mkdocs_document_dates-3.4.1 → mkdocs_document_dates-3.4.5}/mkdocs_document_dates/utils.py

@@ -1,11 +1,13 @@
 import os
 import platform
 import json
+import heapq
 import logging
 import subprocess
 from pathlib import Path
 from datetime import datetime
 from collections import defaultdict
+from mkdocs.structure.files import Files
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
@@ -27,7 +29,7 @@ def get_git_first_commit_time(file_path):
     try:
         # git log --reverse --format="%aI" -- {file_path} | head -n 1
         cmd_list = ['git', 'log', '--reverse', '--format=%aI', '--', file_path]
-        process = subprocess.run(cmd_list, capture_output=True, text=True)
+        process = subprocess.run(cmd_list, capture_output=True, encoding='utf-8')
         if process.returncode == 0 and process.stdout.strip():
             first_line = process.stdout.partition('\n')[0].strip()
             return datetime.fromisoformat(first_line)
@@ -38,18 +40,15 @@ def get_git_first_commit_time(file_path):
 def load_git_cache(docs_dir_path: Path):
     dates_cache = {}
     try:
-        cmd = ['git', 'log', '--reverse', '--no-merges', '--name-only', '--format=%an|%ae|%aI', '--', '*.md']
-        process = subprocess.run(cmd, cwd=docs_dir_path, capture_output=True, text=True)
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            cwd=docs_dir_path, encoding='utf-8'
+        ).strip())
+        rel_docs_path = docs_dir_path.relative_to(git_root).as_posix()
+
+        cmd = ['git', 'log', '--reverse', '--no-merges', '--use-mailmap', '--name-only', '--format=%aN|%aE|%aI', f'--relative={rel_docs_path}', '--', '*.md']
+        process = subprocess.run(cmd, cwd=docs_dir_path, capture_output=True, encoding='utf-8')
         if process.returncode == 0:
-            git_root = Path(subprocess.check_output(
-                ['git', 'rev-parse', '--show-toplevel'],
-                cwd=docs_dir_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(dict)
             first_commit = {}
             current_commit = None
@@ -59,24 +58,21 @@ def load_git_cache(docs_dir_path: Path):
                 if not line:
                     continue
                 if '|' in line:
-                    name, email, created = line.split('|', 2)
                     # 使用元组，更轻量
-                    current_commit = (name, email, created)
+                    current_commit = tuple(line.split('|', 2))
                 elif line.endswith('.md') and current_commit:
-                    if line.startswith(docs_prefix_with_slash):
-                        line = line[prefix_len:]
-                    # 解构元组，避免字典查找
                     name, email, created = current_commit
-                    # 使用有序去重结构，保持作者首次出现顺序
+                    # 使用 defaultdict(dict)结构，有序去重，保持作者首次出现的顺序
+                        # a.巧用 Python 字典的 setdefault 特性来去重（setdefault 为不存在的键提供初始值，不会覆盖已有值）
+                        # b.巧用 Python 3.7+ 字典的插入顺序特性来保留内容插入顺序（Python 3.7+ 字典会保持插入顺序）
                     authors_dict[line].setdefault((name, email), None)
-                    if line not in first_commit:
-                        first_commit[line] = created
+                    first_commit.setdefault(line, created)
 
             # 构建最终的缓存数据
             for file_path in first_commit:
                 authors_list = [
                     {'name': name, 'email': email}
-                    for name, email in authors_dict[file_path].keys()
+                    for name, email in authors_dict[file_path].keys()  # 这里的 keys() 是有序的
                 ]
                 dates_cache[file_path] = {
                     'created': first_commit[file_path],
@@ -103,43 +99,83 @@ 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:
+def get_recently_updated_files(docs_dir_path: Path, files: Files, exclude_list: list, limit: int = 10, recent_enable: bool = False):
+    doc_mtime_map = {}
+    try:
+        # 1. 获取 git 信息，只记录已跟踪的文件首次出现的信息（最近一次提交时间）
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            cwd=docs_dir_path, encoding='utf-8'
+        ).strip())
+        rel_docs_path = docs_dir_path.relative_to(git_root).as_posix()
+
+        cmd = ['git', 'log', '--no-merges', '--use-mailmap', '--format=%aN|%aE|%at', '--name-only', f'--relative={rel_docs_path}', '--', '*.md']
+        process = subprocess.run(cmd, cwd=docs_dir_path, capture_output=True, encoding='utf-8')
+        if process.returncode == 0:
+            result = subprocess.run(
+                ["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
+            for line in process.stdout.splitlines():
+                line = line.strip()
+                if not line:
+                    continue
+                if '|' in line:  # commit header
+                    ts = float(line.split('|')[2])
+                elif line.endswith('.md') and line in tracked_files and ts:
+                    # 只记录第一次出现的文件，即最近一次提交（setdefault 机制不会覆盖已有值）
+                    doc_mtime_map.setdefault(line, ts)
+    except Exception as e:
+        logger.info(f"Error getting git tracked files in {docs_dir_path}: {e}")
+
+    # 2. 构建所有文档的元数据
+    recently_updated_results = []
+    if recent_enable:
+        files_meta = []
+        for file in files:
+            if not file.src_path.endswith('.md'):
                 continue
-            title, url = file.page.title, file.page.url
-        else:
-            title, url = file.name, file.url
+            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
+
+            # 获取文档标题和 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
+
+            # 获取 git 记录的 mtime，没有则 fallback 到文件系统 mtime
+            mtime = doc_mtime_map.get(rel_path, os.path.getmtime(file.abs_src_path))
+
+            # 存储信息
+            files_meta.append((mtime, rel_path, title, url))
+            doc_mtime_map[rel_path] = mtime
 
-        mtime = os.path.getmtime(file.abs_src_path)
-        temp_results.append((mtime, rel_path, title, url))
+        # 3. 构建最近更新列表
+        if files_meta:
+            # heapq 取 top limit
+            top_results = heapq.nlargest(limit, files_meta, key=lambda x: x[0])
+            recently_updated_results = [
+                (datetime.fromtimestamp(mtime).strftime("%Y-%m-%d %H:%M:%S"), *rest)
+                for mtime, *rest in top_results
+            ]
 
-    # 按修改时间倒序
-    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]
+    return doc_mtime_map, recently_updated_results
 
 def read_json_cache(cache_file: Path):
     dates_cache = {}
     if cache_file.exists():
         try:
-            with open(cache_file, "r", encoding='utf-8') as f:
+            with open(cache_file, 'r', encoding='utf-8') as f:
                 dates_cache = json.load(f)
         except (IOError, json.JSONDecodeError) as e:
             logger.warning(f"Error reading from '.dates_cache.json': {str(e)}")
@@ -149,7 +185,7 @@ def read_jsonl_cache(jsonl_file: Path):
     dates_cache = {}
     if jsonl_file.exists():
         try:
-            with open(jsonl_file, "r", encoding='utf-8') as f:
+            with open(jsonl_file, 'r', encoding='utf-8') as f:
                 for line in f:
                     try:
                         entry = json.loads(line.strip())
@@ -166,7 +202,7 @@ def write_jsonl_cache(jsonl_file: Path, dates_cache, tracked_files):
     try:
         # 使用临时文件写入，然后替换原文件，避免写入过程中的问题
         temp_file = jsonl_file.with_suffix('.jsonl.tmp')
-        with open(temp_file, "w", encoding='utf-8') as f:
+        with open(temp_file, 'w', encoding='utf-8') as f:
             for file_path in tracked_files:
                 if file_path in dates_cache:
                     entry = {file_path: dates_cache[file_path]}

{mkdocs_document_dates-3.4.1 → mkdocs_document_dates-3.4.5/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.4.1
+Version: 3.4.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
@@ -36,14 +36,14 @@ A new generation MkDocs plugin for displaying exact **creation time, last update
 
 ## Features
 
-- [x] Always display **exact** meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc.)
+- [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 for manually specifying time and author in `Front Matter`
 - [x] Support for multiple time formats (date, datetime, timeago)
 - [x] Support for multiple author modes (avatar, text, hidden)
 - [x] Flexible display position (top or bottom)
 - [x] Elegant styling (fully customizable)
 - [x] Smart Tooltip Hover Tips
-- [x] Supports display of recently updated documents in an overall list
+- [x] Support list display of recently updated documents
 - [x] Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
 - [x] Cross-platform support (Windows, macOS, Linux)
 - [x] **Ultimate build efficiency**: O(1), no need to set env vars to distinguish runs
@@ -53,7 +53,6 @@ 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)    |
 
-
 ## Installation
 
 ```bash
@@ -77,9 +76,9 @@ plugins:
       position: top            # Display position: top(after title) bottom(end of document)
       type: date               # Date type: date datetime timeago, default: date
       exclude:                 # List of excluded files
-        - temp.md              # Exclude specific file
-        - 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
+        - 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)
       recently-updated: true   # Whether to turn on recently updated data, default: false
@@ -96,7 +95,7 @@ In addition to the above basic configuration, the plug-in also provides a wealth
 - [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
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms
+- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introduction to technical principles, caching mechanisms, and how to use it 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.1 → mkdocs_document_dates-3.4.5}/setup.py

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