mkdocs-document-dates 3.6.1__tar.gz → 3.7.0__tar.gz

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Aaron Wang
+Copyright (c) 2026 Aaron Wang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

mkdocs_document_dates-3.7.0/MANIFEST.in

@@ -0,0 +1,9 @@
+global-exclude tests/*
+global-exclude tests/**/*
+
+global-exclude .DS_Store
+global-exclude __pycache__/*
+global-exclude *.py[cod]
+
+graft mkdocs_document_dates/hooks
+graft mkdocs_document_dates/static

{mkdocs_document_dates-3.6.1/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.7.0}/PKG-INFO

@@ -1,28 +1,19 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.6.1
+Version: 3.7.0
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
-Home-page: https://github.com/jaywhj/mkdocs-document-dates
-Author: Aaron Wang
-Author-email: aaronwqt@gmail.com
-License: MIT
+Author-email: Aaron Wang <aaronwqt@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jaywhj/mkdocs-document-dates
+Project-URL: Repository, https://github.com/jaywhj/mkdocs-document-dates
+Project-URL: Documentation, https://jaywhj.netlify.app/document-dates-en
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs>=1.1.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # mkdocs-document-dates
 
@@ -36,7 +27,7 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 
 ## Features
 
-- [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] 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)
@@ -74,23 +65,23 @@ plugins:
   - document-dates:
       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
+      exclude:                 # List of excluded files (support unix shell-style wildcards)
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
+        - '*/index.md'             # Example: exclude all index.md files in any subfolders
 ```
 
 ## 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): 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
-- [Configuration Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
-- [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 date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
-- [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
+- [Date & Time](https://jaywhj.netlify.app/document-dates-en#Date--Time): Introduces the mechanism for obtaining document dates and methods for personalized customization, support for manually specifying the creation date and last updated date for each document
+- [Author](https://jaywhj.netlify.app/document-dates-en#Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, support for manually specifying the author information for each document, such as name, link, avatar, email, etc.
+- [Avatar](https://jaywhj.netlify.app/document-dates-en#Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
+- [Template Variables](https://jaywhj.netlify.app/document-dates-en#Template-Variables): Can be used to optimize `sitemap.xml` for site SEO
+- [Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#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
+- [Localization Language](https://jaywhj.netlify.app/document-dates-en#Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [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
@@ -99,7 +90,7 @@ See the documentation for details: https://jaywhj.netlify.app/document-dates-en
 
 ## Other Projects
 
-- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. I'll be maintaining this branch continuously (since mkdocs-material will stop being maintained). 
+- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material. Build beautiful sites the way you already know and love. Based on `mkdocs-material-9.7.1` and is named `X`, it provides ongoing maintenance and updates (since mkdocs-material will stop being maintained).  
 Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
 
 <br />

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/README.md

@@ -10,7 +10,7 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 
 ## Features
 
-- [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] 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)
@@ -48,23 +48,23 @@ plugins:
   - document-dates:
       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
+      exclude:                 # List of excluded files (support unix shell-style wildcards)
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
+        - '*/index.md'             # Example: exclude all index.md files in any subfolders
 ```
 
 ## 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): 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
-- [Configuration Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
-- [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 date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
-- [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
+- [Date & Time](https://jaywhj.netlify.app/document-dates-en#Date--Time): Introduces the mechanism for obtaining document dates and methods for personalized customization, support for manually specifying the creation date and last updated date for each document
+- [Author](https://jaywhj.netlify.app/document-dates-en#Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, support for manually specifying the author information for each document, such as name, link, avatar, email, etc.
+- [Avatar](https://jaywhj.netlify.app/document-dates-en#Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
+- [Template Variables](https://jaywhj.netlify.app/document-dates-en#Template-Variables): Can be used to optimize `sitemap.xml` for site SEO
+- [Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#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
+- [Localization Language](https://jaywhj.netlify.app/document-dates-en#Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [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
@@ -73,7 +73,7 @@ See the documentation for details: https://jaywhj.netlify.app/document-dates-en
 
 ## Other Projects
 
-- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. I'll be maintaining this branch continuously (since mkdocs-material will stop being maintained). 
+- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material. Build beautiful sites the way you already know and love. Based on `mkdocs-material-9.7.1` and is named `X`, it provides ongoing maintenance and updates (since mkdocs-material will stop being maintained).  
 Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
 
 <br />

mkdocs_document_dates-3.7.0/mkdocs_document_dates/__init__.py

@@ -0,0 +1 @@
+"""MkDocs Document Dates Plugin."""

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates/cache_manager.py

@@ -1,16 +1,92 @@
 import logging
+import os
 import subprocess
 from pathlib import Path
+from logging.handlers import RotatingFileHandler
+from typing import Optional
 from .utils import read_jsonl_cache, write_jsonl_cache, get_file_creation_time, get_git_first_commit_time
 
 logger = logging.getLogger("mkdocs.plugins.document_dates")
-logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
+_LOGGING_CONFIGURED = False
+
+
+def _default_log_file() -> Path:
+    try:
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            env=_clean_git_env(),
+            encoding='utf-8'
+        ).strip())
+        base_dir = git_root
+    except Exception:
+        base_dir = Path.cwd()
+    return base_dir / "mkdocs_document_dates.log"
+
+def configure_file_logging(log_file: Optional[Path] = None, level: int = logging.DEBUG) -> Optional[Path]:
+    global _LOGGING_CONFIGURED
+    if _LOGGING_CONFIGURED:
+        return log_file
+
+    env_log_file = os.getenv("MKDOCS_DOCUMENT_DATES_LOG_FILE")
+    if log_file is None and env_log_file:
+        log_file = Path(env_log_file).expanduser()
+
+    if log_file is None:
+        return None
+
+    log_file.parent.mkdir(parents=True, exist_ok=True)
+
+    handler = RotatingFileHandler(
+        log_file,
+        maxBytes=5 * 1024 * 1024,
+        backupCount=3,
+        encoding="utf-8",
+    )
+    handler.setLevel(level)
+    handler.setFormatter(logging.Formatter(
+        fmt="%(asctime)s [%(filename)s:%(lineno)d] %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    ))
+
+    logger.setLevel(level)
+    logger.addHandler(handler)
+    logger.propagate = False
+    _LOGGING_CONFIGURED = True
+    logger.debug(f"File logging enabled: {log_file}")
+    return log_file
+
+def _env_truthy(name: str) -> bool:
+    value = os.getenv(name)
+    if value is None:
+        return False
+    value = value.strip().lower()
+    return value not in ("", "0", "false", "no", "off")
+
+
+def _clean_git_env():
+    env = os.environ.copy()
+
+    for k in [
+        "GIT_DIR",
+        "GIT_WORK_TREE",
+        "GIT_COMMON_DIR",
+        "GIT_INDEX_FILE",
+        "GIT_PREFIX",
+        "GIT_SUPER_PREFIX",
+        "GIT_CEILING_DIRECTORIES",
+    ]:
+        env.pop(k, None)
+
+    env["GIT_OPTIONAL_LOCKS"] = "0"
+
+    return env
 
 def find_mkdocs_projects():
     projects = []
     try:
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
+            env=_clean_git_env(),
             encoding='utf-8'
         ).strip())
 
@@ -39,7 +115,7 @@ def setup_gitattributes(docs_dir: Path):
                 content += '\n'
             content += f"{union_merge_line}\n"
             gitattributes_path.write_text(content, encoding='utf-8')
-            subprocess.run(["git", "add", str(gitattributes_path)], check=True)
+            subprocess.run(["git", "add", str(gitattributes_path)], cwd=docs_dir, env=_clean_git_env(), check=True)
             logger.info(f"Updated .gitattributes file: {gitattributes_path}")
             return True
     except (IOError, OSError) as e:
@@ -49,8 +125,12 @@ def setup_gitattributes(docs_dir: Path):
     return False
 
 def update_cache():
-    global_updated = False
+    if os.getenv("MKDOCS_DOCUMENT_DATES_LOG_FILE"):
+        configure_file_logging()
+    elif _env_truthy("MKDOCS_DOCUMENT_DATES_DEBUG"):
+        configure_file_logging(_default_log_file())
 
+    global_updated = False
     for project_dir in find_mkdocs_projects():
         try:
             project_updated = False
@@ -65,7 +145,7 @@ def update_cache():
 
             # 获取docs目录下已跟踪(tracked)的markdown文件
             cmd = ["git", "ls-files", "*.md"]
-            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, encoding='utf-8')
+            result = subprocess.run(cmd, cwd=docs_dir, env=_clean_git_env(), capture_output=True, encoding='utf-8')
             tracked_files = result.stdout.splitlines() if result.stdout else []
 
             if not tracked_files:
@@ -115,4 +195,4 @@ def update_cache():
 
 
 if __name__ == "__main__":
-    update_cache()
+    update_cache()

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates/hooks/pre-commit

@@ -4,7 +4,7 @@ try:
     from mkdocs_document_dates.cache_manager import update_cache
 except Exception:
     import sys
-    # 正常退出（0 状态码），不影响 git 的后续动作
+    # Normal exit (0 status code), don't affect subsequent git actions
     sys.exit(0)
 
 if __name__ == "__main__":

mkdocs_document_dates-3.7.0/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,98 @@
+import os
+import sys
+import subprocess
+from pathlib import Path
+
+DEFAULT_HOOKS_DIRNAME = ".githooks"
+
+
+class HookInstallError(Exception):
+    pass
+
+
+def get_repo_root() -> Path:
+    result = subprocess.run(
+        ["git", "rev-parse", "--show-toplevel"],
+        capture_output=True,
+        text=True,
+    )
+    if result.returncode != 0 or not result.stdout.strip():
+        raise HookInstallError("This command must be run inside a Git repo. Please cd into your project directory and try again.")
+    return Path(result.stdout.strip())
+
+
+def ensure_hooks_dir(repo_root: Path) -> Path:
+    hooks_dir = repo_root / DEFAULT_HOOKS_DIRNAME
+    try:
+        hooks_dir.mkdir(parents=True, exist_ok=True)
+        os.chmod(hooks_dir, 0o755)
+    except Exception as e:
+        raise HookInstallError(f"Failed to create hooks directory: {hooks_dir} ({e})")
+    return hooks_dir
+
+
+def write_hooks(source_dir: Path, target_dir: Path):
+    if not source_dir.exists():
+        raise HookInstallError(f"Hooks source directory not found: {source_dir}")
+
+    shebang = f"#!{sys.executable}"
+
+    try:
+        for file in source_dir.iterdir():
+            if file.name.startswith(".") or not file.is_file():
+                continue
+
+            content = file.read_text(encoding="utf-8")
+
+            if content.startswith("#!"):
+                os.linesep
+                content = shebang + "\n" + content.split("\n", 1)[1]
+            else:
+                content = shebang + "\n" + content
+
+            target = target_dir / file.name
+            target.write_text(content, encoding="utf-8")
+            os.chmod(target, 0o755)
+
+    except Exception as e:
+        raise HookInstallError(f"Failed to write hook files: {e}")
+
+
+def set_hooks_path(repo_root: Path, hooks_dir: Path):
+    rel_path = hooks_dir.relative_to(repo_root).as_posix()
+
+    # # 配置自定义合并驱动
+    # script_path = hooks_dir / 'json_merge_driver.py'
+    # subprocess.run(['git', 'config', 'merge.custom_json_merge.name', 'Custom JSON merge driver'], check=True)
+    # subprocess.run(['git', 'config', 'merge.custom_json_merge.driver', f'"{sys.executable}" "{script_path}" %O %A %B'], check=True)
+
+    result = subprocess.run(
+        ["git", "config", "core.hooksPath", rel_path],
+        cwd=repo_root,
+        capture_output=True,
+        text=True,
+    )
+    if result.returncode != 0:
+        raise HookInstallError(result.stderr.strip() or "Failed to set hooksPath")
+
+
+def install():
+    try:
+        repo_root = get_repo_root()
+        hooks_dir = ensure_hooks_dir(repo_root)
+
+        source_dir = Path(__file__).parent / "hooks"
+
+        write_hooks(source_dir, hooks_dir)
+        set_hooks_path(repo_root, hooks_dir)
+
+        print(f"✔ Hooks installed successfully: {hooks_dir}")
+
+    except HookInstallError as e:
+        print(f"✖ Installation failed: {e}", file=sys.stderr)
+    except Exception as e:
+        print(f"✖ Unexpected error: {e}", file=sys.stderr)
+
+
+if __name__ == "__main__":
+    install()

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates/plugin.py

@@ -43,6 +43,7 @@ class DocumentDatesPlugin(BasePlugin):
 
     def __init__(self):
         super().__init__()
+
         self.dates_cache = {}
         self.last_updated_dates = {}
         self.authors_yml = {}
@@ -97,7 +98,14 @@ class DocumentDatesPlugin(BasePlugin):
         # https://cdn.jsdelivr.net/npm/timeago.js@4.0.2/dist/timeago.min.js
         # https://cdnjs.cloudflare.com/ajax/libs/timeago.js/4.0.2/timeago.full.min.js
         if self.config['type'] == 'timeago':
-            config['extra_javascript'].insert(0, 'assets/document_dates/core/timeago.min.js')
+            scripts = config.get('extra_javascript') or []
+            has_timeago = any(
+                str(item).endswith('timeago.min.js') or str(item).endswith('timeago.full.min.js')
+                for item in scripts
+            )
+            if not has_timeago:
+                scripts.insert(0, 'assets/document_dates/core/timeago.min.js')
+            config['extra_javascript'] = scripts
 
         """
         Tippy.js, for Tooltip
@@ -160,12 +168,17 @@ class DocumentDatesPlugin(BasePlugin):
         
         # 获取作者信息
         authors = self._get_author_info(rel_path, page, config)
-        
-        # 在排除前暴露 meta 信息给前端使用
-        page.meta['document_dates_created'] = created.isoformat()
-        page.meta['document_dates_updated'] = updated.isoformat()
-        page.meta['document_dates_authors'] = authors
-        
+
+        # 按 MaterialX 的数据规范给 meta 填充数据
+        mx = page.meta.setdefault("_mx", {})
+        mx["document_dates"] = {
+            "dates": {
+                "created": created.isoformat(),
+                "updated": updated.isoformat(),
+            },
+            "authors": authors
+        }
+
         # 检查是否需要排除
         if is_excluded(rel_path, self._exclude_patterns):
             return markdown
@@ -202,6 +215,16 @@ class DocumentDatesPlugin(BasePlugin):
         if self.recent_enable:
             self.recent_docs_html = self._render_recently_updated_html(recently_updated_docs)
 
+        # # 便捷访问日期数据函数
+        # def mdd_access(page, domain):
+        #     return (
+        #         page.meta.get("_mx", {})
+        #         .get("document_dates", {})
+        #         .get(domain, {})
+        #     )
+
+        # env.globals["mdd"] = mdd_access
+
         return env
 
     def on_post_page(self, output, page, config):

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates/static/templates/recently_updated_group.html

@@ -56,7 +56,7 @@
     border: 1px solid rgba(142, 142, 142, 0.2);
     border-radius: 8px;
     row-gap: 0;
-    padding: 11px;
+    padding: 12px;
 }
 .article-grid.is-list .card-body {
     display: none;
@@ -109,7 +109,8 @@
     white-space: nowrap;
     margin-right: 10px;
 }
-.card-header:hover {
+.card-header:hover,
+.card-header:focus {
     text-decoration: none !important;
 }
 .card-header:hover .card-title {
@@ -151,9 +152,9 @@
     transition: filter 0.3s ease;
 
     /* Safari 圆角闪烁修复 */
-    transform: translateZ(0);              /* 建立独立合成层 */
-    will-change: transform;                /* 提前告诉浏览器 */
-    -webkit-mask-image: -webkit-radial-gradient(white, black); /* 强制圆角裁剪走 mask 管线 */
+    transform: translateZ(0);
+    will-change: transform;
+    -webkit-mask-image: -webkit-radial-gradient(white, black);
     isolation: isolate;
 }
 .card-cover:hover {

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates/utils.py

@@ -169,7 +169,7 @@ def get_recently_updated_files(existing_dates: dict, files: Files, exclude_list:
             # authors = []
             if file.page:
                 cover = file.page.meta.get('cover', '')
-                # authors = file.page.meta.get('document_dates_authors', [])
+                # authors = file.page.meta._mx.document_dates.authors
                 if file.page.file:
                     summary = extract_summary(file.page.file.content_string)
 

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,28 +1,19 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.6.1
+Version: 3.7.0
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
-Home-page: https://github.com/jaywhj/mkdocs-document-dates
-Author: Aaron Wang
-Author-email: aaronwqt@gmail.com
-License: MIT
+Author-email: Aaron Wang <aaronwqt@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jaywhj/mkdocs-document-dates
+Project-URL: Repository, https://github.com/jaywhj/mkdocs-document-dates
+Project-URL: Documentation, https://jaywhj.netlify.app/document-dates-en
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs>=1.1.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # mkdocs-document-dates
 
@@ -36,7 +27,7 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 
 ## Features
 
-- [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] 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)
@@ -74,23 +65,23 @@ plugins:
   - document-dates:
       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
+      exclude:                 # List of excluded files (support unix shell-style wildcards)
         - temp.md                  # Example: exclude the specified file
         - blog/*                   # Example: exclude all files in blog folder, including subfolders
+        - '*/index.md'             # Example: exclude all index.md files in any subfolders
 ```
 
 ## 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): 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
-- [Configuration Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
-- [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 date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
-- [Add Localization Language](https://jaywhj.netlify.app/document-dates-en#Add-Localization-Language): More localization languages for `timeago` and `tooltip` 
-- [Other Tips](https://jaywhj.netlify.app/document-dates-en#Other-Tips): Introducing the Do's of using plugin in Docker
+- [Date & Time](https://jaywhj.netlify.app/document-dates-en#Date--Time): Introduces the mechanism for obtaining document dates and methods for personalized customization, support for manually specifying the creation date and last updated date for each document
+- [Author](https://jaywhj.netlify.app/document-dates-en#Author): Introduces the mechanism for obtaining document authors and methods for personalized customization, support for manually specifying the author information for each document, such as name, link, avatar, email, etc.
+- [Avatar](https://jaywhj.netlify.app/document-dates-en#Avatar): You can manually specify the avatar for each author, support local file path and URL path
+- [Structure and Style](https://jaywhj.netlify.app/document-dates-en#Structure-and-Style): You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
+- [Template Variables](https://jaywhj.netlify.app/document-dates-en#Template-Variables): Can be used to optimize `sitemap.xml` for site SEO
+- [Recently Updated Module](https://jaywhj.netlify.app/document-dates-en#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
+- [Localization Language](https://jaywhj.netlify.app/document-dates-en#Localization-Language): More localization languages for `timeago` and `tooltip` 
 - [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
@@ -99,7 +90,7 @@ See the documentation for details: https://jaywhj.netlify.app/document-dates-en
 
 ## Other Projects
 
-- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. I'll be maintaining this branch continuously (since mkdocs-material will stop being maintained). 
+- [**MaterialX**](https://github.com/jaywhj/mkdocs-materialx), the next generation of mkdocs-material. Build beautiful sites the way you already know and love. Based on `mkdocs-material-9.7.1` and is named `X`, it provides ongoing maintenance and updates (since mkdocs-material will stop being maintained).  
 Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
 
 <br />

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ mkdocs_document_dates.egg-info/entry_points.txt
 mkdocs_document_dates.egg-info/requires.txt
 mkdocs_document_dates.egg-info/top_level.txt
 mkdocs_document_dates/hooks/pre-commit
+mkdocs_document_dates/static/.DS_Store
 mkdocs_document_dates/static/config/user.config.css
 mkdocs_document_dates/static/config/user.config.js
 mkdocs_document_dates/static/core/core.css

{mkdocs_document_dates-3.6.1 → mkdocs_document_dates-3.7.0}/mkdocs_document_dates.egg-info/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+mdd-hooks = mkdocs_document_dates.hooks_installer:install
 mkdocs-document-dates-hooks = mkdocs_document_dates.hooks_installer:install
 
 [mkdocs.plugins]

mkdocs_document_dates-3.7.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mkdocs-document-dates"
+version = "3.7.0"
+description = "A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.7"
+license = "MIT"
+authors = [{ name = "Aaron Wang", email = "aaronwqt@gmail.com" }]
+dependencies = ["mkdocs>=1.1.0"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/jaywhj/mkdocs-document-dates"
+Repository = "https://github.com/jaywhj/mkdocs-document-dates"
+Documentation = "https://jaywhj.netlify.app/document-dates-en"
+
+[project.entry-points."mkdocs.plugins"]
+document-dates = "mkdocs_document_dates.plugin:DocumentDatesPlugin"
+
+[project.scripts]
+mkdocs-document-dates-hooks = "mkdocs_document_dates.hooks_installer:install"
+mdd-hooks = "mkdocs_document_dates.hooks_installer:install"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["mkdocs_document_dates*"]
+
+[tool.setuptools.package-data]
+mkdocs_document_dates = [
+  "hooks/*",
+  "static/**/*",
+]
+
+[tool.setuptools.exclude-package-data]
+"*" = [
+  ".DS_Store",
+  "**/.DS_Store",
+]

mkdocs_document_dates-3.7.0/setup.py

@@ -0,0 +1,50 @@
+from setuptools import find_packages, setup
+
+
+def legacy_setup():
+    setup(
+        name="mkdocs-document-dates",
+        version="3.7.0",
+        author="Aaron Wang",
+        author_email="aaronwqt@gmail.com",
+        license="MIT",
+        description="A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents",
+        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(),
+        include_package_data=True,
+        install_requires=[
+            "mkdocs>=1.1.0",
+        ],
+        classifiers=[
+            "Programming Language :: Python :: 3",
+            "Operating System :: OS Independent",
+        ],
+        entry_points={
+            "mkdocs.plugins": [
+                "document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin",
+            ],
+            "console_scripts": [
+                "mkdocs-document-dates-hooks=mkdocs_document_dates.hooks_installer:install",
+                "mdd-hooks=mkdocs_document_dates.hooks_installer:install",
+            ],
+        },
+        package_data={
+            "mkdocs_document_dates": [
+                "hooks/*",
+                "static/templates/*",
+                "static/fonts/*",
+                "static/tippy/*",
+                "static/core/*",
+                "static/config/*"
+            ],
+        },
+        python_requires=">=3.7",
+    )
+
+
+try:
+    setup()
+except Exception:
+    legacy_setup()

mkdocs_document_dates-3.6.1/MANIFEST.in

@@ -1,2 +0,0 @@
-global-exclude tests/*
-global-exclude tests/**/*

mkdocs_document_dates-3.6.1/mkdocs_document_dates/__init__.py

@@ -1,6 +0,0 @@
-"""MkDocs Document Dates Plugin."""
-
-from .hooks_installer import install
-
-# 在包被导入时自动执行 hooks 安装
-install()

mkdocs_document_dates-3.6.1/mkdocs_document_dates/hooks_installer.py

@@ -1,120 +0,0 @@
-import os
-import sys
-import logging
-import subprocess
-from pathlib import Path
-import platform
-
-logger = logging.getLogger("mkdocs.plugins.document_dates")
-logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
-
-def get_config_dir():
-    if platform.system().lower().startswith('win'):
-        return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
-    else:
-        # 优先级：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, encoding='utf-8')
-        if result.returncode == 0 and result.stdout.strip().lower() == 'true':
-            return True
-        else:
-            logger.warning(f"Low python version, requires python_requires >=3.7")
-    except Exception as e:
-        logger.info(f"Failed to check {interpreter}: {str(e)}")
-    return False
-
-def detect_python_interpreter():
-    # 检查可能的Python解释器
-    python_interpreters = ['python3', 'python']
-    for interpreter in python_interpreters:
-        if check_python_version(interpreter):
-            return f'#!/usr/bin/env {interpreter}'
-    
-    # 如果都失败了，使用当前运行的Python解释器
-    return f'#!{sys.executable}'
-
-def setup_hooks_directory():
-    config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
-    try:
-        config_dir.mkdir(parents=True, exist_ok=True)
-        os.chmod(config_dir, 0o755)
-        return config_dir
-    except PermissionError:
-        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
-
-def install_hook_file(source_dir: Path, target_dir: Path):
-    try:
-        shebang = detect_python_interpreter()
-        for item in source_dir.iterdir():
-            # 跳过隐藏文件和目录
-            if item.name.startswith('.') or not item.is_file():
-                continue
-            # 添加 shebang 行
-            content = item.read_text(encoding='utf-8')
-            if content.startswith('#!'):
-                content = shebang + os.linesep + content[content.find('\n')+1:]
-            else:
-                content = shebang + os.linesep + content
-
-            target_hook_path = target_dir / item.name
-            target_hook_path.write_text(content, encoding='utf-8')
-            os.chmod(target_hook_path, 0o755)
-
-        return True
-    except Exception as e:
-        logger.error(f"Failed to create hook file {target_hook_path}: {str(e)}")
-    return False
-
-def configure_git_hooks(hooks_dir):
-    try:
-        # 配置自定义合并驱动
-        # script_path = hooks_dir / 'json_merge_driver.py'
-        # subprocess.run(['git', 'config', '--global', 'merge.custom_json_merge.name', 'Custom JSON merge driver'], check=True)
-        # subprocess.run(['git', 'config', '--global', 'merge.custom_json_merge.driver', f'"{sys.executable}" "{script_path}" %O %A %B'], check=True)
-
-        subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)], check=True)
-        logger.info(f"Git hooks successfully installed in: {hooks_dir}")
-        return True
-    except Exception:
-        logger.warning("Git not detected, using plugin in a no-Git environment")
-    return False
-
-def install():
-    try:
-        # 创建hooks目录
-        target_dir = setup_hooks_directory()
-        if not target_dir:
-            return False
-
-        # 安装hook文件
-        source_dir = Path(__file__).parent / 'hooks'
-        if not install_hook_file(source_dir, target_dir):
-            return False
-
-        # 配置git hooks路径
-        return configure_git_hooks(target_dir)
-
-    except Exception as e:
-        logger.error(f"Unexpected error during hooks installation: {str(e)}")
-        return False
-
-if __name__ == '__main__':
-    install()

mkdocs_document_dates-3.6.1/pyproject.toml

@@ -1,4 +0,0 @@
-[build-system]
-requires = ["setuptools>=42"]
-# 使用 legacy backend，继续执行 setup.py
-build-backend = "setuptools.build_meta:__legacy__"

mkdocs_document_dates-3.6.1/setup.py

@@ -1,69 +0,0 @@
-from setuptools import setup, find_packages
-from setuptools.command.install import install
-import atexit
-
-def trigger_hook_install():
-    try:
-        import os
-        import sys
-        package_path = os.path.abspath(os.path.dirname(__file__))
-        if package_path not in sys.path:
-            sys.path.insert(0, package_path)
-        
-        # from mkdocs_document_dates.hooks_installer import install
-        # install()
-        # import mkdocs_document_dates
-        __import__('mkdocs_document_dates')
-    except Exception as e:
-        print(f"Warning: Failed to install Git hooks: {e}")
-
-class CustomInstallCommand(install):
-    def run(self):
-        atexit.register(trigger_hook_install)
-        install.run(self)
-
-
-VERSION = '3.6.1'
-
-setup(
-    name="mkdocs-document-dates",
-    version=VERSION,
-    author="Aaron Wang",
-    author_email="aaronwqt@gmail.com",
-    license="MIT",
-    description="A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents",
-    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(),
-    install_requires=[
-        'mkdocs>=1.1.0',
-    ],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Operating System :: OS Independent",
-    ],
-    cmdclass={
-        'install': CustomInstallCommand,
-    },
-    entry_points={
-        'mkdocs.plugins': [
-            'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
-        ],
-        'console_scripts': [
-            # 提供手动安装 hooks 的入口
-            'mkdocs-document-dates-hooks=mkdocs_document_dates.hooks_installer:install'
-        ],
-    },
-    package_data={
-        'mkdocs_document_dates': [
-            'hooks/*',
-            'static/templates/*',
-            'static/fonts/*',
-            'static/tippy/*',
-            'static/core/*',
-            'static/config/*'
-        ],
-    },
-    python_requires=">=3.7",
-)