mkdocs-document-dates 2.3.1__tar.gz → 2.3.3__tar.gz

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 2.3.1
+Version: 2.3.3
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -16,6 +16,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -86,7 +87,8 @@ modified: 2025-02-23
 # Document Title
 ```
 
-
+- `created` can be replaced by any of the following fields: `created, date, creation_date, created_at, date_created`
+- `modified` can be replaced by any of the following fields: `modified, updated, last_modified, updated_at, date_modified, last_update`
 
 ## Configuration Options
 
@@ -107,18 +109,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/README.md

@@ -64,7 +64,8 @@ modified: 2025-02-23
 # Document Title
 ```
 
-
+- `created` can be replaced by any of the following fields: `created, date, creation_date, created_at, date_created`
+- `modified` can be replaced by any of the following fields: `modified, updated, last_modified, updated_at, date_modified, last_update`
 
 ## Configuration Options
 
@@ -85,18 +86,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/mkdocs_document_dates/__init__.py

@@ -1,6 +1,6 @@
 """MkDocs Document Dates Plugin."""
 
-__version__ = '2.3.1'
+__version__ = '2.3.3'
 
 from .hooks_installer import install
 

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/mkdocs_document_dates/plugin.py

@@ -16,6 +16,8 @@ class DocumentDatesPlugin(BasePlugin):
         ('time_format', config_options.Type(str, default='%H:%M:%S')),
         ('position', config_options.Type(str, default='bottom')),
         ('exclude', config_options.Type(list, default=[])),
+        ('created_field_names', config_options.Type(list, default=['created', 'date', 'creation_date', 'created_at', 'date_created'])),
+        ('modified_field_names', config_options.Type(list, default=['modified', 'updated', 'last_modified', 'updated_at', 'date_modified', 'last_update'])),
     )
 
     def __init__(self):
@@ -51,9 +53,9 @@ class DocumentDatesPlugin(BasePlugin):
         return (
             f"<div class='document-dates-plugin-wrapper'>"
             f"<div class='document-dates-plugin'>"
-            f"<span title='{t['created_time']}'><span class='material-icons'>add_circle</span>"
+            f"<span title='{t['created_time']}: {created.strftime(self.config['date_format'])}'><span class='material-icons'>add_circle</span>"
             f"{self._get_formatted_date(created)}</span>"
-            f"<span title='{t['modified_time']}'><span class='material-icons'>update</span>"
+            f"<span title='{t['modified_time']}: {modified.strftime(self.config['date_format'])}'><span class='material-icons'>update</span>"
             f"{self._get_formatted_date(modified)}</span>"
             f"</div>"
             f"</div>"
@@ -122,9 +124,19 @@ class DocumentDatesPlugin(BasePlugin):
         except ValueError:
             return False
 
+    def _find_meta_date(self, meta: dict, field_names: list, default_date: datetime) -> datetime:
+        """从meta中查找第一个匹配的日期字段"""
+        for field in field_names:
+            if field in meta:
+                result = self._parse_meta_date(meta[field], default_date)
+                if result != default_date:  # 找到有效日期
+                    return result
+        return default_date
+
     def _process_meta_dates(self, meta: dict, created: datetime, modified: datetime) -> tuple[datetime, datetime]:
-        result_created = self._parse_meta_date(meta.get('created'), created)
-        result_modified = self._parse_meta_date(meta.get('modified'), modified)
+        """处理meta中的日期字段，支持多种字段名"""
+        result_created = self._find_meta_date(meta, self.config['created_field_names'], created)
+        result_modified = self._find_meta_date(meta, self.config['modified_field_names'], modified)
         return result_created, result_modified
 
     def _parse_meta_date(self, date_str: str | None, default_date: datetime) -> datetime:

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 2.3.1
+Version: 2.3.3
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -16,6 +16,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -86,7 +87,8 @@ modified: 2025-02-23
 # Document Title
 ```
 
-
+- `created` can be replaced by any of the following fields: `created, date, creation_date, created_at, date_created`
+- `modified` can be replaced by any of the following fields: `modified, updated, last_modified, updated_at, date_modified, last_update`
 
 ## Configuration Options
 
@@ -107,18 +109,18 @@ modified: 2025-02-23
 
 ## Notes
 
-- It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this in your .github/workflows/ci.yml:
-    
+- It still works when using CI/CD build systems (e.g. Github Actions), used a cache file `.dates_cache.json` to solve this problem:
+    1. First, you can configure the workflow like this (penultimate line) in your .github/workflows/ci.yml:
     ```
     ...
     
-      - run: pip install mkdocs-document-dates
-      - run: mkdocs gh-deploy --force
+        - run: pip install mkdocs-document-dates
+        - run: mkdocs gh-deploy --force
     ```
-  - Then update your Markdown files in MkDocs as normal, execute commands such as mkdocs build or directly git add, commit, and push
-    - Make sure you have installed python3 ahead of time and set environment variables
+    2. Then update your Markdown document in MkDocs as normal
+    3. After running git add and git commit, you will see the auto-generated cache file .dates_cache.json (hidden by default) in the `docs` folder under MkDocs
+        - Make sure you have installed python3 ahead of time and set environment variables
+    4. Finally, run git push, and you can see that there are also .dates_cache.json files in the docs directory in the GitHub repository, which means success
 - Priority of time reads:
-  - `Front Matter` > `Cache file` > `Filesystem timestamp`
+    - `Front Matter` > `Cache file` > `Filesystem timestamp`
 - If you are using MkDocs on a Linux system, the modification time is used as the creation time because of system limitations. If you need the exact creation time, you can specify it manually in Front Matter

{mkdocs_document_dates-2.3.1 → mkdocs_document_dates-2.3.3}/setup.py

@@ -7,7 +7,7 @@ try:
 except FileNotFoundError:
     long_description = "A MkDocs plugin for displaying accurate document creation and last modification dates."
 
-VERSION = '2.3.1'
+VERSION = '2.3.3'
 
 setup(
     name="mkdocs-document-dates",