mkdocs-document-dates 3.1.5__tar.gz → 3.1.6__tar.gz

mkdocs_document_dates-3.1.6/MANIFEST.in

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

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1.5
+Version: 3.1.6
 Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -38,14 +38,11 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 - Always display exact meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc)
 - Support for manually specifying time and author in `Front Matter`
 - Support for multiple time formats (date, datetime, timeago)
-- Support for document exclusion mode
 - Flexible display position (top or bottom)
 - Elegant styling (fully customizable)
 - Supports Tooltip Hover Tips
   - Intelligent repositioning to always float optimally in view
   - Supports automatic theme switching following Material's light/dark color scheme
-  - Support for customizing themes, styles, animations
-  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
 - Multi-language support, cross-platform support (Windows, macOS, Linux)
 
 ## Showcases
@@ -80,9 +77,7 @@ plugins:
       exclude:                 # List of excluded files
         - temp.md              # Exclude specific file
         - private/*            # Exclude all files in private directory, including subdirectories
-      
       show_author: true        # Show author or not, default: true
-
 ```
 
 ## Specify time manually
@@ -123,7 +118,7 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. All of it can be customized by modifying the preset values in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
 
 |        Function：        | Location：                               |
 | :----------------------: | ---------------------------------------- |
@@ -131,7 +126,7 @@ The plugin supports deep customization, such as **icon style, font style, theme
 | **Properties & Functions** | `docs/assets/document_dates/user.config.js` |
 | **Localized languages** | `docs/assets/document_dates/languages/` <br />refer to the template file `en.json` for any additions or modifications |
 
-**Tip**: when `type: timeago` is set, timeago.js is enabled to render time dynamically, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
+**Tip**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
 
 - In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
 - In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
@@ -150,12 +145,37 @@ The plugin supports deep customization, such as **icon style, font style, theme
 ![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
 
 ![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
-![07-pop-up-from-top](mkdocs_document_dates/demo_images/07-pop-up-from-top.png)
 ![08-pop-up-from-bottom](mkdocs_document_dates/demo_images/08-pop-up-from-bottom.png)
 
+## Used in templates
+
+You can access the meta-info of a document in a template using the following variables:
+
+- page.meta.document_dates_created
+- page.meta.document_dates_modified
+- page.meta.document_dates_authors
+
+For example like this:
+
+```jinja2
+<div><span>{{ page.meta.document_dates_created }}</span></div>
+<div><span>{{ page.meta.document_dates_modified }}</span></div>
+{% set authors = page.meta.document_dates_authors %}
+{% if authors %}
+<div>
+    {% for author in authors %}
+    {% if author.email %}<a href="mailto:{{ author.email }}">{{ author.name }}</a>
+    {% else %}<span>{{ author.name }}</span>{% endif %}
+    {% endfor %}
+</div>
+{% endif %}
+```
+
+**Full example**: set the correct lastmod for [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/sitemap.xml) so that search engines can better handle SEO and thus increase your site's exposure (override path: `docs/overrides/sitemap.xml`)
+
 ## Other Tips
 
-- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't delete it:
+- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
     - `docs/.dates_cache.jsonl`, cache file
     - `docs/.gitattributes`, merge mechanism for cache file
 - The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it, in addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
@@ -167,11 +187,11 @@ The plugin supports deep customization, such as **icon style, font style, theme
 A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
-    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is more accurate, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is exact, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
-    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
-    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time in advance, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information. There are many solutions:
+    - Method 1: Use the last git commit time as the last update time and the first git commit time as the creation time, mkdocs-git-revision-date-localized-plugin does this. (This way, there will be a margin of error and dependency on git)
+    - Method 2: Cache the original time in advance, and then read the cache subsequently (The time is exact and no dependency on any environment). The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
     1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific git action occurs, such as every time commit is performed

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/README.md

@@ -11,14 +11,11 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 - Always display exact meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc)
 - Support for manually specifying time and author in `Front Matter`
 - Support for multiple time formats (date, datetime, timeago)
-- Support for document exclusion mode
 - Flexible display position (top or bottom)
 - Elegant styling (fully customizable)
 - Supports Tooltip Hover Tips
   - Intelligent repositioning to always float optimally in view
   - Supports automatic theme switching following Material's light/dark color scheme
-  - Support for customizing themes, styles, animations
-  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
 - Multi-language support, cross-platform support (Windows, macOS, Linux)
 
 ## Showcases
@@ -53,9 +50,7 @@ plugins:
       exclude:                 # List of excluded files
         - temp.md              # Exclude specific file
         - private/*            # Exclude all files in private directory, including subdirectories
-      
       show_author: true        # Show author or not, default: true
-
 ```
 
 ## Specify time manually
@@ -96,7 +91,7 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. All of it can be customized by modifying the preset values in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
 
 |        Function：        | Location：                               |
 | :----------------------: | ---------------------------------------- |
@@ -104,7 +99,7 @@ The plugin supports deep customization, such as **icon style, font style, theme
 | **Properties & Functions** | `docs/assets/document_dates/user.config.js` |
 | **Localized languages** | `docs/assets/document_dates/languages/` <br />refer to the template file `en.json` for any additions or modifications |
 
-**Tip**: when `type: timeago` is set, timeago.js is enabled to render time dynamically, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
+**Tip**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
 
 - In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
 - In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
@@ -123,12 +118,37 @@ The plugin supports deep customization, such as **icon style, font style, theme
 ![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
 
 ![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
-![07-pop-up-from-top](mkdocs_document_dates/demo_images/07-pop-up-from-top.png)
 ![08-pop-up-from-bottom](mkdocs_document_dates/demo_images/08-pop-up-from-bottom.png)
 
+## Used in templates
+
+You can access the meta-info of a document in a template using the following variables:
+
+- page.meta.document_dates_created
+- page.meta.document_dates_modified
+- page.meta.document_dates_authors
+
+For example like this:
+
+```jinja2
+<div><span>{{ page.meta.document_dates_created }}</span></div>
+<div><span>{{ page.meta.document_dates_modified }}</span></div>
+{% set authors = page.meta.document_dates_authors %}
+{% if authors %}
+<div>
+    {% for author in authors %}
+    {% if author.email %}<a href="mailto:{{ author.email }}">{{ author.name }}</a>
+    {% else %}<span>{{ author.name }}</span>{% endif %}
+    {% endfor %}
+</div>
+{% endif %}
+```
+
+**Full example**: set the correct lastmod for [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/sitemap.xml) so that search engines can better handle SEO and thus increase your site's exposure (override path: `docs/overrides/sitemap.xml`)
+
 ## Other Tips
 
-- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't delete it:
+- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
     - `docs/.dates_cache.jsonl`, cache file
     - `docs/.gitattributes`, merge mechanism for cache file
 - The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it, in addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
@@ -140,11 +160,11 @@ The plugin supports deep customization, such as **icon style, font style, theme
 A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
-    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is more accurate, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is exact, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
-    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
-    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time in advance, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information. There are many solutions:
+    - Method 1: Use the last git commit time as the last update time and the first git commit time as the creation time, mkdocs-git-revision-date-localized-plugin does this. (This way, there will be a margin of error and dependency on git)
+    - Method 2: Cache the original time in advance, and then read the cache subsequently (The time is exact and no dependency on any environment). The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
     1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific git action occurs, such as every time commit is performed

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/cache_manager.py

@@ -26,7 +26,7 @@ def find_mkdocs_projects():
                 projects.append(config_file.parent)
 
         if not projects:
-            logging.info("No MkDocs projects found in the repository")
+            logging.warning("No MkDocs projects found in the repository")
     except subprocess.CalledProcessError as e:
         logging.error(f"Failed to find the Git repository root: {e}")
     except Exception as e:
@@ -67,7 +67,7 @@ def setup_gitattributes(docs_dir):
     updated = False
     try:
         gitattributes_path = docs_dir / '.gitattributes'
-        union_config_line = ".dates_cache.jsonl merge=union"        
+        union_config_line = ".dates_cache.jsonl merge=union"
         if gitattributes_path.exists():
             with open(gitattributes_path, 'r', encoding='utf-8') as f:
                 content = f.read()
@@ -98,7 +98,7 @@ def read_json_cache(cache_file):
             with open(cache_file, "r", encoding='utf-8') as f:
                 dates_cache = json.load(f)
         except (IOError, json.JSONDecodeError) as e:
-            logging.error(f"Failed to read existing JSON cache file: {e}")
+            logging.warning(f"Error reading from '.dates_cache.json': {str(e)}")
     return dates_cache
 
 def read_jsonl_cache(jsonl_file):
@@ -115,7 +115,7 @@ def read_jsonl_cache(jsonl_file):
                     except (json.JSONDecodeError, StopIteration) as e:
                         logging.warning(f"Skipping invalid JSONL line: {e}")
         except IOError as e:
-            logging.error(f"Failed to read existing JSONL cache file: {e}")
+            logging.warning(f"Error reading from '.dates_cache.jsonl': {str(e)}")
     return dates_cache
 
 def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
@@ -144,88 +144,81 @@ def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
 
 def update_cache():
     global_updated = False
-    try:
-        for project_dir in find_mkdocs_projects():
-            try:
-                project_updated = False
 
-                docs_dir = project_dir / 'docs'
-                if not docs_dir.exists():
-                    logging.error(f"Document directory does not exist: {docs_dir}")
-                    continue
+    for project_dir in find_mkdocs_projects():
+        try:
+            project_updated = False
 
-                # 设置.gitattributes文件
-                gitattributes_updated = setup_gitattributes(docs_dir)
-                if gitattributes_updated:
-                    global_updated = True
+            docs_dir = project_dir / 'docs'
+            if not docs_dir.exists():
+                logging.error(f"Document directory does not exist: {docs_dir}")
+                continue
 
-                # 获取docs目录下已跟踪(tracked)的markdown文件
-                cmd = ["git", "ls-files", "*.md"]
-                result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True, check=True)
-                tracked_files = result.stdout.splitlines() if result.stdout else []
+            # 设置.gitattributes文件
+            gitattributes_updated = setup_gitattributes(docs_dir)
+            if gitattributes_updated:
+                global_updated = True
 
-                if not tracked_files:
-                    logging.info(f"No tracked markdown files found in {docs_dir}")
-                    continue
+            # 获取docs目录下已跟踪(tracked)的markdown文件
+            cmd = ["git", "ls-files", "*.md"]
+            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True, check=True)
+            tracked_files = result.stdout.splitlines() if result.stdout else []
 
-                # 读取旧的JSON缓存文件（如果存在）
-                json_cache_file = docs_dir / '.dates_cache.json'
-                json_dates_cache = read_json_cache(json_cache_file)
+            if not tracked_files:
+                logging.info(f"No tracked markdown files found in {docs_dir}")
+                continue
 
-                # 读取新的JSONL缓存文件（如果存在）
-                jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
-                jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
+            # 读取旧的JSON缓存文件（如果存在）
+            json_cache_file = docs_dir / '.dates_cache.json'
+            json_dates_cache = read_json_cache(json_cache_file)
 
-                # 根据 git已跟踪的文件来更新
-                for file_path in tracked_files:
-                    try:
-                        rel_path = file_path
-                        full_path = docs_dir / rel_path
-
-                        # 如果文件已在JSONL缓存中，跳过
-                        if rel_path in jsonl_dates_cache:
-                            continue
-
-                        # 处理新文件或迁移旧JSON缓存
-                        if rel_path in json_dates_cache:
-                            jsonl_dates_cache[rel_path] = json_dates_cache[rel_path]
-                            project_updated = True
-                        elif full_path.exists():
-                            created_time = get_file_creation_time(full_path)
-                            if not jsonl_cache_file.exists() and not json_cache_file.exists():
-                                git_time = get_git_first_commit_time(full_path)
-                                if git_time is not None:
-                                    created_time = min(created_time, git_time)
-                            jsonl_dates_cache[rel_path] = {
-                                "created": created_time.isoformat()
-                            }
-                            project_updated = True
-                    except Exception as e:
-                        logging.error(f"Error processing file {file_path}: {e}")
+            # 读取新的JSONL缓存文件（如果存在）
+            jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
+            jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
+
+            # 根据 git已跟踪的文件来更新
+            for rel_path in tracked_files:
+                try:
+                    # 如果文件已在JSONL缓存中，跳过
+                    if rel_path in jsonl_dates_cache:
                         continue
 
-                # 标记删除不再跟踪的文件
-                files_to_remove = set(jsonl_dates_cache.keys()) - set(tracked_files)
-                if files_to_remove:
-                    project_updated = True
-                    logging.info(f"Removing {len(files_to_remove)} untracked files from cache")
-
-                # 如果有更新，写入JSONL缓存文件
-                if project_updated or not jsonl_cache_file.exists():
-                    if write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files):
-                        global_updated = True
-                else:
-                    logging.info(f"No updates needed for {jsonl_cache_file}")
-            except subprocess.CalledProcessError as e:
-                logging.error(f"Failed to execute git command: {e}")
-                continue
-            except Exception as e:
-                logging.error(f"Error processing project directory {project_dir}: {e}")
-                continue
+                    full_path = docs_dir / rel_path
+                    # 处理新文件或迁移旧JSON缓存
+                    if rel_path in json_dates_cache:
+                        jsonl_dates_cache[rel_path] = json_dates_cache[rel_path]
+                        project_updated = True
+                    elif full_path.exists():
+                        created_time = get_file_creation_time(full_path)
+                        if not jsonl_cache_file.exists() and not json_cache_file.exists():
+                            git_time = get_git_first_commit_time(full_path)
+                            if git_time:
+                                created_time = min(created_time, git_time)
+                        jsonl_dates_cache[rel_path] = {
+                            "created": created_time.isoformat()
+                        }
+                        project_updated = True
+                except Exception as e:
+                    logging.error(f"Error processing file {rel_path}: {e}")
+                    continue
+
+            # 标记删除不再跟踪的文件
+            files_to_remove = set(jsonl_dates_cache.keys()) - set(tracked_files)
+            if files_to_remove:
+                project_updated = True
+                logging.info(f"Removing {len(files_to_remove)} untracked files from cache")
+
+            # 如果有更新，写入JSONL缓存文件
+            if project_updated or not jsonl_cache_file.exists():
+                if write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files):
+                    global_updated = True
+        except subprocess.CalledProcessError as e:
+            logging.error(f"Failed to execute git command: {e}")
+            continue
+        except Exception as e:
+            logging.error(f"Error processing project directory {project_dir}: {e}")
+            continue
 
-    except Exception as e:
-        logging.error(f"Unexpected error in update_cache: {e}")
-    
     return global_updated
 
 

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/hooks_installer.py

@@ -43,14 +43,6 @@ def detect_python_interpreter():
     # 如果都失败了，使用当前运行的Python解释器
     return f'#!{sys.executable}'
 
-def check_git_available():
-    try:
-        subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
-        return True
-    except Exception:
-        logging.warning("Git not detected, skip hooks installation")
-        return False
-
 def setup_hooks_directory():
     config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
     try:
@@ -95,16 +87,12 @@ def configure_git_hooks(hooks_dir):
         )
         logging.info(f"Git hooks successfully installed in: {hooks_dir}")
         return True
-    except Exception as e:
-        logging.error(f"Failed to set git hooks path: {str(e)}")
+    except Exception:
+        logging.warning("Git not detected, failed to set git hooks path")
         return False
 
 def install():
     try:
-        # 检查git是否可用
-        if not check_git_available():
-            return False
-
         # 创建hooks目录
         hooks_dir = setup_hooks_directory()
         if not hooks_dir:

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/plugin.py

@@ -1,13 +1,13 @@
 import os
 import json
 import shutil
-import platform
 import logging
 import subprocess
 from datetime import datetime
 from pathlib import Path
 from mkdocs.plugins import BasePlugin
 from mkdocs.config import config_options
+from .cache_manager import read_json_cache, read_jsonl_cache, get_file_creation_time, get_git_first_commit_time
 
 # 配置日志等级 (INFO WARNING ERROR)
 logging.basicConfig(
@@ -80,44 +80,15 @@ class DocumentDatesPlugin(BasePlugin):
 
         # 加载日期缓存
         jsonl_cache_file = docs_dir_path / '.dates_cache.jsonl'
-        if jsonl_cache_file.exists():
-            try:
-                with open(jsonl_cache_file, "r", encoding='utf-8') as f:
-                    for line in f:
-                        try:
-                            entry = json.loads(line.strip())
-                            if entry and isinstance(entry, dict) and len(entry) == 1:
-                                file_path, file_info = next(iter(entry.items()))
-                                self.dates_cache[file_path] = file_info
-                        except (json.JSONDecodeError, StopIteration) as e:
-                            logging.warning(f"Skipping invalid JSONL line: {e}")
-                logging.info(f"Loaded cache from JSONL file: {jsonl_cache_file}")
-            except IOError as e:
-                logging.warning(f"Error reading from '.dates_cache.jsonl': {str(e)}")
-        
+        self.dates_cache = read_jsonl_cache(jsonl_cache_file)
+
         # 兼容旧版缓存文件
-        json_cache_file = docs_dir_path / '.dates_cache.json'
-        if not self.dates_cache and json_cache_file.exists():
-            try:
-                with open(json_cache_file, "r", encoding='utf-8') as f:
-                    self.dates_cache = json.load(f)
-                logging.info(f"Loaded cache from JSON file: {json_cache_file}")
-            except (json.JSONDecodeError, KeyError) as e:
-                logging.warning(f"Error reading from '.dates_cache.json': {str(e)}")        
-        
-        
-        if 'extra_css' not in config:
-            config['extra_css'] = []
-        if 'extra_javascript' not in config:
-            config['extra_javascript'] = []
-        
-        # 加载图标 Google Fonts Icons: https://fonts.google.com/icons
-        material_icons_url = 'https://fonts.googleapis.com/icon?family=Material+Icons'
-        if material_icons_url not in config['extra_css']:
-            config['extra_css'].append(material_icons_url)
-        
-        # 加载 Tooltip 资源：Tippy.js
+        if not self.dates_cache:
+            json_cache_file = docs_dir_path / '.dates_cache.json'
+            self.dates_cache = read_json_cache(json_cache_file)
+
         """
+        Tippy.js
         # core
             https://unpkg.com/@popperjs/core@2/dist/umd/popper.min.js
             https://unpkg.com/tippy.js@6/dist/tippy.umd.min.js
@@ -148,12 +119,20 @@ class DocumentDatesPlugin(BasePlugin):
             if not target_config.exists():
                 shutil.copy2(source_config, target_config)
 
+        
+        # 加载图标 Google Fonts Icons: https://fonts.google.com/icons
+        material_icons_url = 'https://fonts.googleapis.com/icon?family=Material+Icons'
+        if material_icons_url not in config['extra_css']:
+            config['extra_css'].append(material_icons_url)
+        
         # 加载 timeago.js
         # 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')
-            config['extra_javascript'].insert(1, 'assets/document_dates/core/timeago-load.js')
+            config['extra_javascript'][0:0] = [
+                'assets/document_dates/core/timeago.min.js',
+                'assets/document_dates/core/timeago-load.js'
+            ]
 
         # 加载 Tippy CSS 文件
         tippy_css_dir = dest_dir / 'tippy'
@@ -180,42 +159,36 @@ class DocumentDatesPlugin(BasePlugin):
         return config
 
     def on_page_markdown(self, markdown, page, config, files):
-        file_path = page.file.abs_src_path
         # 获取相对路径，src_uri 总是以"/"分隔
         rel_path = getattr(page.file, 'src_uri', None)
         if not rel_path:
             rel_path = page.file.src_path
             if os.sep != '/':
                 rel_path = rel_path.replace(os.sep, '/')
-
-        # 检查是否需要排除
-        if self._is_excluded(rel_path):
-            return markdown
+        file_path = page.file.abs_src_path
         
-        # 获取时间信息，优先从 front matter 获取
+        # 获取时间信息
         created = self._find_meta_date(page.meta, self.config['created_field_names'])
         modified = self._find_meta_date(page.meta, self.config['modified_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)
-  
+        
         # 获取作者信息
-        author = None
-        if self.config['show_author']:
-            author = self._process_meta_author(page.meta)
-            if not author:
-                author = self._get_git_authors(file_path)
-                if not author:
-                    # 读 mkdocs.yml 中的 site_author
-                    if config.get('site_author'):
-                        author = Author(name=config.get('site_author'))
-                    else:
-                        author = self._get_local_author()
+        authors = self._get_author_info(file_path, page, config)
+        
+        # 在排除前暴露 meta 信息给前端使用
+        page.meta['document_dates_created'] = created.isoformat()
+        page.meta['document_dates_modified'] = modified.isoformat()
+        page.meta['document_dates_authors'] = authors
+        
+        # 检查是否需要排除
+        if self._is_excluded(rel_path):
+            return markdown
         
         # 生成日期和作者信息 HTML
-        info_html = self._generate_html_info(created, modified, author)
+        info_html = self._generate_html_info(created, modified, authors)
         
         # 将信息写入 markdown
         return self._insert_date_info(markdown, info_html)
@@ -278,44 +251,20 @@ class DocumentDatesPlugin(BasePlugin):
                     continue
         return None
 
-    def _get_git_first_commit_time(self, file_path):
-        if self.is_git_repo:
-            try:
-                # git log --reverse --format="%aI" --date=iso -- {file_path} | head -n 1
-                result = subprocess.run(['git', 'log', '--reverse', '--format=%aI', '--', file_path], capture_output=True, text=True)
-                if result.returncode == 0:
-                    first_line = result.stdout.partition('\n')[0].strip()
-                    if first_line:
-                        return datetime.fromisoformat(first_line).replace(tzinfo=None)
-            except Exception as e:
-                logging.warning(f"Error getting git first commit time for {file_path}: {e}")
-        return None
-
     def _get_file_creation_time(self, file_path, rel_path):
         # 优先从缓存中读取
         if rel_path in self.dates_cache:
             return datetime.fromisoformat(self.dates_cache[rel_path]['created'])
         
-        # 获取文件系统时间
-        stat = os.stat(file_path)
-        system = platform.system().lower()
-        fs_time = None
-        if system.startswith('win'):  # Windows
-            fs_time = datetime.fromtimestamp(stat.st_ctime)
-        elif system == 'darwin':  # macOS
-            try:
-                fs_time = datetime.fromtimestamp(stat.st_birthtime)
-            except AttributeError:
-                fs_time = datetime.fromtimestamp(stat.st_ctime)
-        else:  # Linux, 没有创建时间，使用修改时间
-            fs_time = datetime.fromtimestamp(stat.st_mtime)
+        # 从文件系统获取
+        fs_time = get_file_creation_time(file_path)
         
         # 获取Git首次提交时间
-        git_time = self._get_git_first_commit_time(file_path)
-        
-        # 取两者更早的时间
-        if git_time is not None:
-            return min(fs_time, git_time)
+        if self.is_git_repo:
+            git_time = get_git_first_commit_time(file_path)
+            # 取两者更早的时间
+            if git_time:
+                return min(fs_time, git_time)
         return fs_time
 
     def _get_file_modification_time(self, file_path):
@@ -338,6 +287,20 @@ class DocumentDatesPlugin(BasePlugin):
         return datetime.fromtimestamp(stat.st_mtime)
 
 
+    def _get_author_info(self, file_path, page, config):
+        if not self.config['show_author']:
+            return None
+        # 1. meta author
+        authors = self._process_meta_author(page.meta)
+        if authors:
+            return authors
+        # 2. git author
+        authors = self._get_git_authors(file_path)
+        if authors:
+            return authors
+        # 3. site_author 或 PC username
+        return [Author(name=config.get('site_author') or Path.home().name)]
+
     def _process_meta_author(self, meta):
         try:
             # 1. 处理 author 对象，或 author 字符串
@@ -351,8 +314,8 @@ class DocumentDatesPlugin(BasePlugin):
                     # 提取扩展属性
                     extra_attrs = {k: str(v) for k, v in author_data.items() 
                                 if k not in ['name', 'email']}
-                    return Author(name=name, email=email, **extra_attrs)
-                return Author(name=str(author_data))
+                    return [Author(name=name, email=email, **extra_attrs)]
+                return [Author(name=str(author_data))]
             
             # 2. 处理独立字段，匹配 author_field_mapping 配置
             name = ''
@@ -370,8 +333,8 @@ class DocumentDatesPlugin(BasePlugin):
             
             if name or email:
                 if not name and email:
-                    name = email.split('@')[0]
-                return Author(name=name, email=email)
+                    name = email.partition('@')[0]
+                return [Author(name=name, email=email)]
         except Exception as e:
             logging.warning(f"Error processing author meta: {e}")
         return None
@@ -380,12 +343,6 @@ class DocumentDatesPlugin(BasePlugin):
         if not self.is_git_repo:
             return None
         try:
-            # # 检查文件是否在 Git 中
-            # check_file = subprocess.run(f'git ls-files --error-unmatch {file_path}',
-            #                           shell=True, capture_output=True, text=True)
-            # if check_file.returncode != 0:
-            #     return None
-
             # 获取作者信息（为了兼容性，不采用管道命令，在 python 中处理去重）
             # git_log_cmd = f'git log --format="%an|%ae" -- {file_path} | sort | uniq'
             # git_log_cmd = f'git log --format="%an|%ae" -- {file_path} | grep -vE "bot|noreply|ci|github-actions|dependabot|renovate" | sort | uniq'            
@@ -402,16 +359,11 @@ class DocumentDatesPlugin(BasePlugin):
                 name, email = line.split('|')
                 authors_map[line] = Author(name=name, email=email)
 
-            authors = list(authors_map.values())
-            return authors[0] if len(authors) == 1 else authors or None
+            return list(authors_map.values()) or None
         except Exception as e:
             logging.warning(f"Failed to get git author info: {str(e)}")
         return None
 
-    def _get_local_author(self):
-        username = Path.home().name
-        return Author(name=username)
-
 
     def _get_formatted_date(self, date):
         if self.config['type'] == 'timeago':
@@ -420,7 +372,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, modified, author=None):
+    def _generate_html_info(self, created, modified, authors=None):
         html = ""
         try:
             locale = 'zh_CN' if self.config['locale'] == 'zh' else self.config['locale']
@@ -439,11 +391,20 @@ class DocumentDatesPlugin(BasePlugin):
             )
             
             # 添加作者信息
-            if self.config['show_author'] and author:
-                if isinstance(author, list):
+            if self.config['show_author'] and authors:
+                if len(authors) == 1:
+                    author, = authors
+                    author_tooltip = f'<a href="mailto:{author.email}">{author.name}</a>' if author.email else author.name
+                    html += (
+                        f"<span data-tippy-content='{self.translation.get('author', 'Author')}: {author_tooltip}'>"
+                        f"<span class='material-icons' data-icon='doc_author'></span>"
+                        f"{author.name}</span>"
+                        # f"{author_tooltip}</span>"
+                    )
+                else:
                     # 多个作者的情况
-                    authors_info = ', '.join(a.name for a in author if a.name)
-                    authors_tooltip = ',&nbsp;'.join(f'<a href="mailto:{a.email}">{a.name}</a>' if a.email else a.name for a in author)
+                    authors_info = ', '.join(a.name for a in authors if a.name)
+                    authors_tooltip = ',&nbsp;'.join(f'<a href="mailto:{a.email}">{a.name}</a>' if a.email else a.name for a in authors)
                     
                     html += (
                         f"<span data-tippy-content='{self.translation.get('authors', 'Authors')}: {authors_tooltip}'>"
@@ -451,15 +412,6 @@ class DocumentDatesPlugin(BasePlugin):
                         f"{authors_info}</span>"
                         # f"{authors_tooltip}</span>"
                     )
-                else:
-                    # 单个作者的情况
-                    author_tooltip = f'<a href="mailto:{author.email}">{author.name}</a>' if author.email else author.name
-                    html += (
-                        f"<span data-tippy-content='{self.translation.get('author', 'Author')}: {author_tooltip}'>"
-                        f"<span class='material-icons' data-icon='doc_author'></span>"
-                        f"{author.name}</span>"
-                        # f"{author_tooltip}</span>"
-                    )
             
             html += f"</div></div>"
         

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/static/config/user.config.css

@@ -13,16 +13,16 @@
 /* Customized icons, just change the icon name.
     Google Fonts Icons (2500+): https://fonts.google.com/icons
 
-    add_circle: add_circle, add_circle, note_add, more_time
-    update:     update, check_circle, task, refresh
-    person:     person, account_circle
-    group:      group, groups */
+    doc_created:  add_circle, add_circle, note_add, more_time
+    doc_modified: 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: "add_circle";
+    content: "more_time";
 }
 .document-dates-plugin .material-icons[data-icon="doc_modified"]::before {
-    content: "update";
+    content: "refresh";
 }
 .document-dates-plugin .material-icons[data-icon="doc_author"]::before {
     content: "person";

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/static/core/core.css

@@ -24,21 +24,22 @@
 }
 
 /* Customized icons, just change the icon name.
-    Google Fonts Icons (2500+): https://fonts.google.com/icons  */
+    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_author:   person, account_circle
+    doc_authors:  group, groups */
 .document-dates-plugin .material-icons[data-icon="doc_created"]::before {
-    /* add_circle, add_circle, note_add, add */
-    content: "add_circle";
+    content: "more_time";
 }
 .document-dates-plugin .material-icons[data-icon="doc_modified"]::before {
-    /* update, check_circle, task, refresh */
-    content: "update";
+    content: "refresh";
 }
 .document-dates-plugin .material-icons[data-icon="doc_author"]::before {
-    /* person, account_circle */
     content: "person";
 }
 .document-dates-plugin .material-icons[data-icon="doc_authors"]::before {
-    /* group, groups */
     content: "group";
 }
 

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1.5
+Version: 3.1.6
 Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -38,14 +38,11 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 - Always display exact meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc)
 - Support for manually specifying time and author in `Front Matter`
 - Support for multiple time formats (date, datetime, timeago)
-- Support for document exclusion mode
 - Flexible display position (top or bottom)
 - Elegant styling (fully customizable)
 - Supports Tooltip Hover Tips
   - Intelligent repositioning to always float optimally in view
   - Supports automatic theme switching following Material's light/dark color scheme
-  - Support for customizing themes, styles, animations
-  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
 - Multi-language support, cross-platform support (Windows, macOS, Linux)
 
 ## Showcases
@@ -80,9 +77,7 @@ plugins:
       exclude:                 # List of excluded files
         - temp.md              # Exclude specific file
         - private/*            # Exclude all files in private directory, including subdirectories
-      
       show_author: true        # Show author or not, default: true
-
 ```
 
 ## Specify time manually
@@ -123,7 +118,7 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. All of it can be customized by modifying the preset values in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
 
 |        Function：        | Location：                               |
 | :----------------------: | ---------------------------------------- |
@@ -131,7 +126,7 @@ The plugin supports deep customization, such as **icon style, font style, theme
 | **Properties & Functions** | `docs/assets/document_dates/user.config.js` |
 | **Localized languages** | `docs/assets/document_dates/languages/` <br />refer to the template file `en.json` for any additions or modifications |
 
-**Tip**: when `type: timeago` is set, timeago.js is enabled to render time dynamically, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
+**Tip**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
 
 - In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
 - In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
@@ -150,12 +145,37 @@ The plugin supports deep customization, such as **icon style, font style, theme
 ![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
 
 ![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
-![07-pop-up-from-top](mkdocs_document_dates/demo_images/07-pop-up-from-top.png)
 ![08-pop-up-from-bottom](mkdocs_document_dates/demo_images/08-pop-up-from-bottom.png)
 
+## Used in templates
+
+You can access the meta-info of a document in a template using the following variables:
+
+- page.meta.document_dates_created
+- page.meta.document_dates_modified
+- page.meta.document_dates_authors
+
+For example like this:
+
+```jinja2
+<div><span>{{ page.meta.document_dates_created }}</span></div>
+<div><span>{{ page.meta.document_dates_modified }}</span></div>
+{% set authors = page.meta.document_dates_authors %}
+{% if authors %}
+<div>
+    {% for author in authors %}
+    {% if author.email %}<a href="mailto:{{ author.email }}">{{ author.name }}</a>
+    {% else %}<span>{{ author.name }}</span>{% endif %}
+    {% endfor %}
+</div>
+{% endif %}
+```
+
+**Full example**: set the correct lastmod for [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/sitemap.xml) so that search engines can better handle SEO and thus increase your site's exposure (override path: `docs/overrides/sitemap.xml`)
+
 ## Other Tips
 
-- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't delete it:
+- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
     - `docs/.dates_cache.jsonl`, cache file
     - `docs/.gitattributes`, merge mechanism for cache file
 - The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it, in addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
@@ -167,11 +187,11 @@ The plugin supports deep customization, such as **icon style, font style, theme
 A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
-    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is more accurate, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is exact, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
-    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
-    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time in advance, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information. There are many solutions:
+    - Method 1: Use the last git commit time as the last update time and the first git commit time as the creation time, mkdocs-git-revision-date-localized-plugin does this. (This way, there will be a margin of error and dependency on git)
+    - Method 2: Cache the original time in advance, and then read the cache subsequently (The time is exact and no dependency on any environment). The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
     1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific git action occurs, such as every time commit is performed

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+MANIFEST.in
 README.md
 setup.py
 mkdocs_document_dates/__init__.py

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.1.6}/setup.py

@@ -6,7 +6,6 @@ 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)
@@ -20,7 +19,6 @@ def trigger_hook_install():
 
 class CustomInstallCommand(install):
     def run(self):
-        # 注册在安装结束时执行 trigger_hook_install
         atexit.register(trigger_hook_install)
         install.run(self)
 
@@ -30,7 +28,7 @@ try:
 except FileNotFoundError:
     long_description = "An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents."
 
-VERSION = '3.1.5'
+VERSION = '3.1.6'
 
 setup(
     name="mkdocs-document-dates",
@@ -59,7 +57,7 @@ setup(
             'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
         ],
         'console_scripts': [
-            # 提供手动执行 hooks 的入口
+            # 提供手动安装 hooks 的入口
             'mkdocs-document-dates-hooks=mkdocs_document_dates.hooks_installer:install'
         ],
     },