mkdocs-document-dates 2.2.0__tar.gz → 2.3.0__tar.gz

{mkdocs_document_dates-2.2.0 → mkdocs_document_dates-2.3.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.2.0
+Version: 2.3.0
 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
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs>=1.0.0
@@ -26,12 +26,12 @@ English | [简体中文](README_zh.md)
 
 
 
-A MkDocs plugin for displaying **accurate** document creation and last modification dates.
+A MkDocs plugin for displaying <mark>accurate</mark> document creation and last modification dates.
 
 ## Features
 
 - Automatically displays document creation and last modification times
-- No Git dependency, uses filesystem timestamps directly
+- **No Git dependency**, uses filesystem timestamps directly
 - Supports manual date specification in `Front Matter`
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
@@ -40,6 +40,7 @@ A MkDocs plugin for displaying **accurate** document creation and last modificat
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
+- Support for CI/CD build systems (e.g. Github Actions)
 
 ## Installation
 
@@ -79,7 +80,7 @@ You can also manually specify the date of a Markdown document in its `Front Matt
 ```yaml
 ---
 created: 2023-01-01
-modified: 2023-12-31
+modified: 2025-02-23
 ---
 
 # Document Title
@@ -89,33 +90,35 @@ modified: 2023-12-31
 
 ## Configuration Options
 
-- `type` : Date type (default: `date` )
+- **type** : Date type (default: `date` )
   - `date` : Display date only
   - `datetime` : Display date and time
   - `timeago` : Display relative time (e.g., 2 minutes ago)
-- `locale` : Localization (default: `en` )
+- **locale** : Localization (default: `en` )
   - Supports: `zh zh_tw en es fr de ar ja ko ru`
-- `date_format` : Date format (default: `%Y-%m-%d`)
+- **date_format** : Date format (default: `%Y-%m-%d`)
   - Supports all Python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc.
-- `time_format` : Time format (default: `%H:%M:%S`)
-- `position` : Display position (default: `bottom`)
+- **time_format** : Time format (default: `%H:%M:%S`)
+- **position** : Display position (default: `bottom`)
   - `top` : Display after the first heading
   - `bottom` : Display at the end of the document
-- `exclude` : File exclusion list (default: [] )
+- **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
 ## Notes
 
-- Creation time behavior varies across operating systems:
-  - Windows: Uses file creation time
-  - macOS: Uses file creation time (birthtime)
-  - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - 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:
+  - You can configure it like this (line 3) in your .github/workflows/ci.yml:
+    
     ```
     ...
     
       - 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
+- Priority of time reads:
+  - `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.2.0 → mkdocs_document_dates-2.3.0}/README.md

@@ -4,12 +4,12 @@ English | [简体中文](README_zh.md)
 
 
 
-A MkDocs plugin for displaying **accurate** document creation and last modification dates.
+A MkDocs plugin for displaying <mark>accurate</mark> document creation and last modification dates.
 
 ## Features
 
 - Automatically displays document creation and last modification times
-- No Git dependency, uses filesystem timestamps directly
+- **No Git dependency**, uses filesystem timestamps directly
 - Supports manual date specification in `Front Matter`
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
@@ -18,6 +18,7 @@ A MkDocs plugin for displaying **accurate** document creation and last modificat
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
+- Support for CI/CD build systems (e.g. Github Actions)
 
 ## Installation
 
@@ -57,7 +58,7 @@ You can also manually specify the date of a Markdown document in its `Front Matt
 ```yaml
 ---
 created: 2023-01-01
-modified: 2023-12-31
+modified: 2025-02-23
 ---
 
 # Document Title
@@ -67,33 +68,35 @@ modified: 2023-12-31
 
 ## Configuration Options
 
-- `type` : Date type (default: `date` )
+- **type** : Date type (default: `date` )
   - `date` : Display date only
   - `datetime` : Display date and time
   - `timeago` : Display relative time (e.g., 2 minutes ago)
-- `locale` : Localization (default: `en` )
+- **locale** : Localization (default: `en` )
   - Supports: `zh zh_tw en es fr de ar ja ko ru`
-- `date_format` : Date format (default: `%Y-%m-%d`)
+- **date_format** : Date format (default: `%Y-%m-%d`)
   - Supports all Python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc.
-- `time_format` : Time format (default: `%H:%M:%S`)
-- `position` : Display position (default: `bottom`)
+- **time_format** : Time format (default: `%H:%M:%S`)
+- **position** : Display position (default: `bottom`)
   - `top` : Display after the first heading
   - `bottom` : Display at the end of the document
-- `exclude` : File exclusion list (default: [] )
+- **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
 ## Notes
 
-- Creation time behavior varies across operating systems:
-  - Windows: Uses file creation time
-  - macOS: Uses file creation time (birthtime)
-  - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - 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:
+  - You can configure it like this (line 3) in your .github/workflows/ci.yml:
+    
     ```
     ...
     
       - 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
+- Priority of time reads:
+  - `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.2.0 → mkdocs_document_dates-2.3.0}/mkdocs_document_dates/__init__.py

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

{mkdocs_document_dates-2.2.0 → mkdocs_document_dates-2.3.0}/mkdocs_document_dates/hooks/pre-commit

@@ -50,7 +50,6 @@ def get_file_dates(file_path):
 
 def update_dates_cache():
     """更新文档时间缓存"""
-    print("开始更新文档时间缓存...")
     for project_dir in find_mkdocs_projects():
         docs_dir = project_dir / 'docs'
         if not docs_dir.exists():
@@ -75,12 +74,11 @@ def update_dates_cache():
             continue
 
         cache_file = docs_dir / '.dates_cache.json'
-        print(f"正在写入缓存文件: {cache_file}")
         try:
             with open(cache_file, "w") as f:
                 json.dump(dates_cache, f, indent=2, ensure_ascii=False)
             subprocess.run(["git", "add", str(cache_file)], check=True)
-            print(f"缓存文件 {cache_file} 已更新.")
+            # print(f"缓存文件 {cache_file} 已更新.")
         except Exception as e:
             print(f"写入缓存文件时出错: {e}", file=sys.stderr)
             raise

{mkdocs_document_dates-2.2.0 → mkdocs_document_dates-2.3.0}/mkdocs_document_dates/hooks_installer.py

@@ -7,10 +7,9 @@ import platform
 
 def get_config_dir():
     """获取用户配置目录"""
-    system = platform.system().lower()
-    if system.startswith('win'):
+    if platform.system().lower().startswith('win'):
         return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
-    else:  # macOS 和 Linux 统一使用 ~/.config
+    else:
         return Path.home() / '.config'
 
 def install():
@@ -20,7 +19,7 @@ def install():
         try:
             subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
         except (subprocess.CalledProcessError, FileNotFoundError):
-            print("提示: 未检测到 Git，跳过 hooks 安装")
+            print("提示: 未检测到 Git, 跳过 hooks 安装")
             return False
         
         # 准备配置目录
@@ -36,12 +35,12 @@ def install():
 
         hook_path = config_dir / 'pre-commit'
 
-        # 复制 hook 文件
+        # 复制 hook 文件到配置目录
         source_hook = Path(__file__).parent / 'hooks' / 'pre-commit'
         if not source_hook.exists():
             print(f"错误: 源 hook 文件不存在: {source_hook}")
             return False
-            
+
         try:
             shutil.copy2(source_hook, hook_path)
         except PermissionError:
@@ -51,15 +50,14 @@ def install():
             print(f"错误: 复制文件失败, 原因: {e}")
             return False
 
-        # 设置文件权限（Unix-like 系统）
-        if not platform.system().lower().startswith('win'):
-            try:
-                os.chmod(config_dir, 0o755)
-                os.chmod(hook_path, 0o755)
-            except OSError as e:
-                print(f"警告: 设置权限时出错: {e}")
+        # 设置文件权限
+        try:
+            os.chmod(config_dir, 0o755)
+            os.chmod(hook_path, 0o755)
+        except OSError as e:
+            print(f"警告: 设置权限时出错: {e}")
 
-        # 配置 git hooks 路径
+        # 配置全局 git hooks 路径
         try:
             subprocess.run(['git', 'config', '--global', 'core.hooksPath', 
                           str(config_dir)], check=True, encoding='utf-8')

{mkdocs_document_dates-2.2.0 → mkdocs_document_dates-2.3.0}/mkdocs_document_dates/plugin.py

@@ -85,7 +85,7 @@ class DocumentDatesPlugin(BasePlugin):
             return markdown
         
         # 获取文件时间
-        created, modified = self._get_file_dates(file_path, config)  # 传入 config
+        created, modified = self._get_file_dates(file_path, config)
         
         # 处理 front matter 中的时间
         created, modified = self._process_meta_dates(page.meta, created, modified)
@@ -151,10 +151,9 @@ class DocumentDatesPlugin(BasePlugin):
         except (ValueError, TypeError):
             return default_date
 
-    def _get_file_dates(self, file_path, config):  # 添加 config 参数
+    def _get_file_dates(self, file_path, config):
         """获取文件的创建时间和修改时间"""
         try:
-            # 从传入的 config 中获取 docs_dir
             docs_dir = Path(config['docs_dir'])
             rel_path = str(Path(file_path).relative_to(docs_dir))
             
@@ -172,15 +171,15 @@ class DocumentDatesPlugin(BasePlugin):
             # 如果缓存不存在或文件不在缓存中，使用文件系统时间
             stat = os.stat(file_path)
             modified = datetime.fromtimestamp(stat.st_mtime)
-            
+
             system = platform.system().lower()
-            if system == 'darwin':  # macOS
+            if system.startswith('win'):  # Windows
+                created = datetime.fromtimestamp(stat.st_ctime)
+            elif system == 'darwin':  # macOS
                 try:
                     created = datetime.fromtimestamp(stat.st_birthtime)
                 except AttributeError:
                     created = datetime.fromtimestamp(stat.st_ctime)
-            elif system == 'windows':  # Windows
-                created = datetime.fromtimestamp(stat.st_ctime)
             else:  # Linux 和其他系统
                 created = modified
 

{mkdocs_document_dates-2.2.0 → mkdocs_document_dates-2.3.0}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.2.0
+Version: 2.3.0
 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
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mkdocs>=1.0.0
@@ -26,12 +26,12 @@ English | [简体中文](README_zh.md)
 
 
 
-A MkDocs plugin for displaying **accurate** document creation and last modification dates.
+A MkDocs plugin for displaying <mark>accurate</mark> document creation and last modification dates.
 
 ## Features
 
 - Automatically displays document creation and last modification times
-- No Git dependency, uses filesystem timestamps directly
+- **No Git dependency**, uses filesystem timestamps directly
 - Supports manual date specification in `Front Matter`
 - Cross-platform support (Windows, macOS, Linux)
 - Support for multiple time formats (date, datetime, timeago)
@@ -40,6 +40,7 @@ A MkDocs plugin for displaying **accurate** document creation and last modificat
 - Material Design icons, Elegant styling
 - Lightweight with no extra dependencies
 - Multi-language support
+- Support for CI/CD build systems (e.g. Github Actions)
 
 ## Installation
 
@@ -79,7 +80,7 @@ You can also manually specify the date of a Markdown document in its `Front Matt
 ```yaml
 ---
 created: 2023-01-01
-modified: 2023-12-31
+modified: 2025-02-23
 ---
 
 # Document Title
@@ -89,33 +90,35 @@ modified: 2023-12-31
 
 ## Configuration Options
 
-- `type` : Date type (default: `date` )
+- **type** : Date type (default: `date` )
   - `date` : Display date only
   - `datetime` : Display date and time
   - `timeago` : Display relative time (e.g., 2 minutes ago)
-- `locale` : Localization (default: `en` )
+- **locale** : Localization (default: `en` )
   - Supports: `zh zh_tw en es fr de ar ja ko ru`
-- `date_format` : Date format (default: `%Y-%m-%d`)
+- **date_format** : Date format (default: `%Y-%m-%d`)
   - Supports all Python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc.
-- `time_format` : Time format (default: `%H:%M:%S`)
-- `position` : Display position (default: `bottom`)
+- **time_format** : Time format (default: `%H:%M:%S`)
+- **position** : Display position (default: `bottom`)
   - `top` : Display after the first heading
   - `bottom` : Display at the end of the document
-- `exclude` : File exclusion list (default: [] )
+- **exclude** : File exclusion list (default: [] )
   - Supports glob patterns, e.g., ["private/\*", "temp.md", "drafts/\*.md"]
 
 ## Notes
 
-- Creation time behavior varies across operating systems:
-  - Windows: Uses file creation time
-  - macOS: Uses file creation time (birthtime)
-  - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - 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:
+  - You can configure it like this (line 3) in your .github/workflows/ci.yml:
+    
     ```
     ...
     
       - 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
+- Priority of time reads:
+  - `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.2.0 → mkdocs_document_dates-2.3.0}/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.2.0'
+VERSION = '2.3.0'
 
 setup(
     name="mkdocs-document-dates",
@@ -31,12 +31,12 @@ setup(
             'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
         ],
         'console_scripts': [
-            # 提供命令行工具，允许用户手动执行 hooks 安装
+            # 提供手动执行 hooks 安装的入口
             'mkdocs-document-dates-hooks=mkdocs_document_dates.hooks_installer:install'
         ],
     },
     package_data={
         'mkdocs_document_dates': ['hooks/*'],
     },
-    python_requires=">=3.6",
+    python_requires=">=3.7",
 )