mkdocs-document-dates 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

mkdocs_document_dates/plugin.py

@@ -1,4 +1,5 @@
 import os
+import platform
 from datetime import datetime
 from pathlib import Path
 from mkdocs.plugins import BasePlugin
@@ -103,9 +104,20 @@ class DocumentDatesPlugin(BasePlugin):
         # 检查 frontmatter 中的日期
         meta = getattr(page, 'meta', {})
         if 'created_date' in meta:
-            created = datetime.fromisoformat(meta['created_date'])
+            try:
+                date_str = str(meta['created_date']).strip("'\"")  # 移除可能存在的引号
+                created = datetime.fromisoformat(date_str)
+            except (ValueError, TypeError):
+                # 如果解析失败，保持原有的文件系统日期
+                pass
+                
         if 'modified_date' in meta:
-            modified = datetime.fromisoformat(meta['modified_date'])
+            try:
+                date_str = str(meta['modified_date']).strip("'\"")  # 移除可能存在的引号
+                modified = datetime.fromisoformat(date_str)
+            except (ValueError, TypeError):
+                # 如果解析失败，保持原有的文件系统日期
+                pass
         
         # 格式化并插入日期信息
         date_info = self.format_date_info(created, modified)
@@ -113,7 +125,6 @@ class DocumentDatesPlugin(BasePlugin):
 
     def get_file_dates(self, file_path):
         """获取文件的创建时间和修改时间"""
-        import platform
         
         stat = os.stat(file_path)
         modified = datetime.fromtimestamp(stat.st_mtime)

mkdocs_document_dates-0.3.0.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.2
+Name: mkdocs-document-dates
+Version: 0.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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.0.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# mkdocs-document-dates
+
+English | [简体中文](README_zh.md)
+
+
+
+A MkDocs plugin for displaying **accurate** document creation and last modification dates.
+
+## Features
+
+- Automatically displays document creation and last modification times
+- Supports manual date specification in `Front Matter`
+- No Git dependency, uses filesystem timestamps directly
+- Cross-platform support (Windows, macOS, Linux)
+- Configurable date and time formats
+- Flexible display position (top or bottom)
+- File exclusion rules support
+- Material Design icons
+- Elegant styling
+- Lightweight with no extra dependencies
+
+## Installation
+
+```bash
+pip install mkdocs-document-dates
+```
+
+## Configuration
+
+Add the plugin to your mkdocs.yml:
+
+```yaml
+plugins:
+  - document-dates
+```
+
+Or, customize the configuration:
+
+```yaml
+plugins:
+  - document-dates:
+      date_format: '%Y-%m-%d'    # Date format
+      show_time: false           # Whether to show time
+      time_format: '%H:%M:%S'    # Time format
+      position: bottom           # Display position: top (after title) or bottom (end of document)
+      exclude:                   # List of file patterns to exclude
+        - "private/*"            # Exclude all files in private directory
+        - "drafts/*.md"         # Exclude all markdown files in drafts directory
+        - "temp.md"             # Exclude specific file
+        - "*.tmp"               # Exclude all files with .tmp extension
+```
+
+## Manual Date Specification
+
+You can also manually specify the date of a Markdown document in its `Front Matter` :
+
+```yaml
+---
+created_date: 2023-01-01
+modified_date: 2023-12-31
+---
+
+# Document Title
+```
+
+## Configuration Options
+
+- `date_format`: Date format (default: %Y-%m-%d)
+  - Supports all Python datetime format strings, examples: %Y-%m-%d, %b %d, %Y, etc.
+- `show_time`: Whether to show time (default: false)
+  - true: Show both date and time
+  - false: Show date only
+- `time_format`: Time format (default: %H:%M:%S)
+  - Only effective when show_time is true
+- `position`: Display position (default: bottom)
+  - top: Display after the first heading
+  - bottom: Display at the end of document
+- `exclude`: List of files to exclude (default: [])
+  - Supports glob patterns, example: ["private/*", "temp.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
+- For accurate creation times, it's recommended to use Front Matter for manual specification
+

mkdocs_document_dates-0.3.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+mkdocs_document_dates/__init__.py,sha256=yom7psmObebsZY0AwCN1PjlGUwPkny2r6NyzoO0cudg,58
+mkdocs_document_dates/plugin.py,sha256=uxjid20k8O3PnOdCV0FMxnE6iLp_J3aPJ3RIsNQcUUE,5397
+mkdocs_document_dates-0.3.0.dist-info/LICENSE,sha256=1YKfCs5WKSk-bON8a68WZE5to1B2klCrHBYiuaVCThM,514
+mkdocs_document_dates-0.3.0.dist-info/METADATA,sha256=E2lIEIgHJ0Kw9ZaavKM-Fqrv-AIm9Gsz10nFsbuNb8o,3252
+mkdocs_document_dates-0.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+mkdocs_document_dates-0.3.0.dist-info/entry_points.txt,sha256=gI-OFLGjDG6-oLEfyevl3Gwwj2GcqVFQeX3bvL1IF8o,83
+mkdocs_document_dates-0.3.0.dist-info/top_level.txt,sha256=yWkKQdNuAJJVqUQ9uLa5xD4x_Gux4IfOUpy8Ryagdwc,22
+mkdocs_document_dates-0.3.0.dist-info/RECORD,,

mkdocs_document_dates-0.1.0.dist-info/METADATA

@@ -1,110 +0,0 @@
-Metadata-Version: 2.2
-Name: mkdocs-document-dates
-Version: 0.1.0
-Summary: 一个用于显示文档创建日期和最后修改日期的 MkDocs 插件
-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
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: mkdocs>=1.0.0
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# mkdocs-document-dates
-
-[English](README_en.md) | 简体中文
-
-
-
-一个用于显示准确的文档创建日期和最后修改日期的 MkDocs 插件。
-
-## 特性
-
-- 自动显示文档的创建时间和最后修改时间
-- 支持在 `Front Matter` 中手动指定日期
-- 不依赖 Git，直接使用文件系统的时间戳
-- 跨平台支持（Windows、macOS、Linux）
-- 可配置的日期和时间格式
-- 灵活的显示位置（顶部或底部）
-- 支持文件排除规则
-- Material Design 风格的图标
-- 优雅的样式设计
-- 轻量级，无额外依赖
-
-## 安装
-
-```bash
-pip install mkdocs-document-dates
-```
-
-## 配置
-
-在你的 mkdocs.yml 中添加插件即可：
-
-```yaml
-plugins:
-  - document-dates
-```
-
-或者，你要自定义配置：
-
-```yaml
-plugins:
-  - document-dates:
-      date_format: '%Y-%m-%d'    # 日期格式
-      show_time: false           # 是否显示时间
-      time_format: '%H:%M:%S'    # 时间格式
-      position: bottom           # 显示位置：top（标题后）或 bottom（文档末尾）
-      exclude:                   # 排除的文件模式列表
-        - "private/*"            # 排除 private 目录下的所有文件
-        - "drafts/*.md"         # 排除 drafts 目录下的所有 markdown 文件
-        - "temp.md"             # 排除特定文件
-        - "*.tmp"               # 排除所有 .tmp 后缀的文件
-```
-
-## 手动指定日期
-
-你也可以为 Markdown 文档手动指定日期，在 Markdown 文档的 `Front Matter` 中设置：
-
-```yaml
----
-created_date: '2023-01-01'
-modified_date: '2023-12-31'
----
-
-# 文档标题
-```
-
-## 配置选项
-
-- date_format: 日期格式（默认：%Y-%m-%d）
-  - 支持所有 Python datetime 格式化字符串，例如：%Y年%m月%d日、%b %d, %Y 等
-- show_time: 是否显示时间（默认：false）
-  - true: 同时显示日期和时间
-  - false: 仅显示日期
-- time_format: 时间格式（默认：%H:%M:%S）
-  - 仅在 show_time 为 true 时生效
-- position: 显示位置（默认：bottom）
-  - top: 在文档第一个标题后显示
-  - bottom: 在文档末尾显示
-- exclude: 排除文件列表（默认：[]）
-  - 支持 glob 模式，例如：["private/*", "temp.md"]
-
-## 注意事项
-
-- 创建时间在不同操作系统上的行为可能不同：
-  - Windows: 使用文件创建时间
-  - macOS: 使用文件创建时间（birthtime）
-  - Linux: 由于系统限制，使用修改时间作为创建时间
-- 如果需要准确的创建时间，建议使用 Front Matter 手动指定
-

mkdocs_document_dates-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-mkdocs_document_dates/__init__.py,sha256=yom7psmObebsZY0AwCN1PjlGUwPkny2r6NyzoO0cudg,58
-mkdocs_document_dates/plugin.py,sha256=x5oFH2K54Wlr5DJUSKG6gl85tZ9HHrgjbnaksGuqkzc,4900
-mkdocs_document_dates-0.1.0.dist-info/LICENSE,sha256=1YKfCs5WKSk-bON8a68WZE5to1B2klCrHBYiuaVCThM,514
-mkdocs_document_dates-0.1.0.dist-info/METADATA,sha256=q-Eft96oExZ_ARZLhaNGy5uS_mR9Tsfk0yCTcosG1Jw,3193
-mkdocs_document_dates-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-mkdocs_document_dates-0.1.0.dist-info/entry_points.txt,sha256=gI-OFLGjDG6-oLEfyevl3Gwwj2GcqVFQeX3bvL1IF8o,83
-mkdocs_document_dates-0.1.0.dist-info/top_level.txt,sha256=yWkKQdNuAJJVqUQ9uLa5xD4x_Gux4IfOUpy8Ryagdwc,22
-mkdocs_document_dates-0.1.0.dist-info/RECORD,,