mkdocs-document-dates 2.3.2__tar.gz → 2.3.5__tar.gz

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 2.3.2
+Version: 2.3.5
 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
@@ -36,7 +37,8 @@ A MkDocs plugin for displaying <mark>accurate</mark> document creation and last
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
 - Flexible display position (top or bottom)
-- Support for document exclusion
+- Support for customizing display styles (CSS)
+- Support for document exclusion mode
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
@@ -86,7 +88,12 @@ 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`
 
+## Custom Display Styles (CSS)
+
+Simply modify the code in the file `docs/assets/document_dates.css`
 
 ## Configuration Options
 
@@ -105,7 +112,7 @@ modified: 2025-02-23
 - **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
-## Notes
+## Tips
 
 - 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:

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/README.md

@@ -14,7 +14,8 @@ A MkDocs plugin for displaying <mark>accurate</mark> document creation and last
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
 - Flexible display position (top or bottom)
-- Support for document exclusion
+- Support for customizing display styles (CSS)
+- Support for document exclusion mode
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
@@ -64,7 +65,12 @@ 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`
 
+## Custom Display Styles (CSS)
+
+Simply modify the code in the file `docs/assets/document_dates.css`
 
 ## Configuration Options
 
@@ -83,7 +89,7 @@ modified: 2025-02-23
 - **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
-## Notes
+## Tips
 
 - 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:

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/mkdocs_document_dates/__init__.py

@@ -1,7 +1,5 @@
 """MkDocs Document Dates Plugin."""
 
-__version__ = '2.3.1'
-
 from .hooks_installer import install
 
 # 在包被导入时自动执行 hooks 安装

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/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):
@@ -36,10 +38,11 @@ class DocumentDatesPlugin(BasePlugin):
         
         # 添加自定义 CSS
         css_file = Path(config['docs_dir']) / 'assets' / 'document_dates.css'
-        css_file.parent.mkdir(parents=True, exist_ok=True)
-        css_file.write_text(self._get_css_content())
+        if not css_file.exists():
+            css_file.parent.mkdir(parents=True, exist_ok=True)
+            css_file.write_text(self._get_css_content())
         config['extra_css'].append('assets/document_dates.css')
-        
+
         return config
 
     def _get_date_info(self, created, modified):
@@ -48,8 +51,10 @@ class DocumentDatesPlugin(BasePlugin):
             locale = 'en'
         t = self.translations[locale]
         
+        position_class = 'document-dates-top' if self.config['position'] == 'top' else 'document-dates-bottom'
+        
         return (
-            f"<div class='document-dates-plugin-wrapper'>"
+            f"<div class='document-dates-plugin-wrapper {position_class}'>"
             f"<div class='document-dates-plugin'>"
             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>"
@@ -122,9 +127,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.5/mkdocs_document_dates/styles.py

@@ -0,0 +1,42 @@
+
+DOCUMENT_DATES_CSS = """
+.document-dates-plugin {
+    color: #8e8e8e;
+    font-size: 0.75rem;
+    padding: 0.2rem 0;
+    opacity: 0.7;
+    display: flex;
+    gap: 1.5rem;
+    align-items: center;
+    margin-bottom: 0.3rem;
+}
+.document-dates-plugin span {
+    display: inline-flex;
+    align-items: center;
+    gap: 0.3rem;
+}
+.document-dates-plugin .material-icons {
+    font-size: 0.9rem;
+    opacity: 0.7;
+}
+
+
+/* top position style */
+.document-dates-plugin-wrapper.document-dates-top {
+    margin-top: -1.2rem;
+    padding-bottom: 0.3rem;
+    border-bottom: 1px solid rgba(0, 0, 0, 0.07);
+}
+/* bottom position style */
+.document-dates-plugin-wrapper.document-dates-bottom {
+    margin: 1rem 0;
+    padding-bottom: 0.3rem;
+    border-bottom: 1px solid rgba(0, 0, 0, 0.07);
+}
+
+
+/* Hide the footnote divider immediately following the date information with the CSS adjacent sibling selector */
+.document-dates-plugin-wrapper + .footnote hr {
+    display: none;
+}
+"""

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/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.2
+Version: 2.3.5
 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
@@ -36,7 +37,8 @@ A MkDocs plugin for displaying <mark>accurate</mark> document creation and last
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
 - Flexible display position (top or bottom)
-- Support for document exclusion
+- Support for customizing display styles (CSS)
+- Support for document exclusion mode
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
@@ -86,7 +88,12 @@ 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`
 
+## Custom Display Styles (CSS)
+
+Simply modify the code in the file `docs/assets/document_dates.css`
 
 ## Configuration Options
 
@@ -105,7 +112,7 @@ modified: 2025-02-23
 - **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
-## Notes
+## Tips
 
 - 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:

{mkdocs_document_dates-2.3.2 → mkdocs_document_dates-2.3.5}/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.2'
+VERSION = '2.3.5'
 
 setup(
     name="mkdocs-document-dates",

mkdocs_document_dates-2.3.2/mkdocs_document_dates/styles.py

@@ -1,27 +0,0 @@
-
-DOCUMENT_DATES_CSS = """
-.document-dates-plugin {
-    color: #8e8e8e;
-    font-size: 0.75rem;
-    padding: 0.2rem 0;
-    opacity: 0.8;
-    display: flex;
-    gap: 1.5rem;
-    align-items: center;
-    margin-bottom: 0.3rem;
-}
-.document-dates-plugin span {
-    display: inline-flex;
-    align-items: center;
-    gap: 0.3rem;
-}
-.document-dates-plugin .material-icons {
-    font-size: 0.9rem;
-    opacity: 0.7;
-}
-.document-dates-plugin-wrapper {
-    margin: 0.3rem 0 1rem 0;
-    border-bottom: 1px solid rgba(0, 0, 0, 0.07);
-    padding-bottom: 0.5rem;
-}
-"""