mkdocs-document-dates 0.1.0__tar.gz

mkdocs_document_dates-0.1.0/LICENSE

@@ -0,0 +1,12 @@
+MIT License
+
+Copyright (c) 2024 Aaron Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+[... 后续 MIT 许可证内容 ...]

mkdocs_document_dates-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+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/README.md

@@ -0,0 +1,88 @@
+# 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/mkdocs_document_dates/__init__.py

@@ -0,0 +1,3 @@
+"""MkDocs Document Dates Plugin."""
+
+__version__ = '0.1.0'

mkdocs_document_dates-0.1.0/mkdocs_document_dates/plugin.py

@@ -0,0 +1,139 @@
+import os
+from datetime import datetime
+from pathlib import Path
+from mkdocs.plugins import BasePlugin
+from mkdocs.config import config_options
+
+class DocumentDatesPlugin(BasePlugin):
+    config_scheme = (
+        ('date_format', config_options.Type(str, default='%Y-%m-%d')),
+        ('show_time', config_options.Type(bool, default=False)),
+        ('time_format', config_options.Type(str, default='%H:%M:%S')),
+        ('position', config_options.Type(str, default='bottom')),
+        ('exclude', config_options.Type(list, default=[])),
+    )
+
+    def __init__(self):
+        super().__init__()
+
+    def get_css_content(self):
+        """返回插件的 CSS 样式"""
+        return """
+.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;
+}
+"""
+
+    def on_config(self, config):
+        """配置插件并添加必要的 CSS"""
+        if 'extra_css' not in config:
+            config['extra_css'] = []
+        
+        # 添加 Material 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)
+        
+        # 添加自定义 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())
+        config['extra_css'].append('assets/document_dates.css')
+        
+        return config
+
+    def format_date_info(self, created, modified):
+        """格式化日期信息的 HTML"""
+        return (
+            f"\n\n"
+            f"<div class='document-dates-plugin-wrapper'>"
+            f"<div class='document-dates-plugin'>"
+            f"<span><span class='material-icons'>add_circle</span>"
+            f"{self.format_date(created)}</span>"
+            f"<span><span class='material-icons'>update</span>"
+            f"{self.format_date(modified)}</span>"
+            f"</div>"
+            f"</div>\n"
+        )
+
+    def insert_date_info(self, markdown, date_info):
+        """根据配置将日期信息插入到合适的位置"""
+        if self.config['position'] == 'top':
+            lines = markdown.split('\n')
+            for i, line in enumerate(lines):
+                if line.startswith('#'):
+                    lines.insert(i + 1, date_info)
+                    return '\n'.join(lines)
+            return date_info + markdown
+        return markdown + "\n\n" + date_info
+
+    def on_page_markdown(self, markdown, page, config, files):
+        """处理页面内容，添加日期信息"""
+        file_path = page.file.abs_src_path
+        
+        # 检查是否在排除列表中
+        for exclude_pattern in self.config['exclude']:
+            if Path(file_path).match(exclude_pattern):
+                return markdown
+        
+        # 直接获取日期信息
+        created, modified = self.get_file_dates(file_path)
+        
+        # 检查 frontmatter 中的日期
+        meta = getattr(page, 'meta', {})
+        if 'created_date' in meta:
+            created = datetime.fromisoformat(meta['created_date'])
+        if 'modified_date' in meta:
+            modified = datetime.fromisoformat(meta['modified_date'])
+        
+        # 格式化并插入日期信息
+        date_info = self.format_date_info(created, modified)
+        return self.insert_date_info(markdown, date_info)
+
+    def get_file_dates(self, file_path):
+        """获取文件的创建时间和修改时间"""
+        import platform
+        
+        stat = os.stat(file_path)
+        modified = datetime.fromtimestamp(stat.st_mtime)
+        
+        system = platform.system().lower()
+        if 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 和其他系统
+            # Linux 没有可靠的创建时间，使用修改时间作为创建时间
+            created = modified
+        
+        return created, modified
+
+    def format_date(self, date):
+        if self.config['show_time']:
+            return date.strftime(f"{self.config['date_format']} {self.config['time_format']}")
+        return date.strftime(self.config['date_format'])
+

mkdocs_document_dates-0.1.0/mkdocs_document_dates.egg-info/PKG-INFO

@@ -0,0 +1,110 @@
+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/mkdocs_document_dates.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+mkdocs_document_dates/__init__.py
+mkdocs_document_dates/plugin.py
+mkdocs_document_dates.egg-info/PKG-INFO
+mkdocs_document_dates.egg-info/SOURCES.txt
+mkdocs_document_dates.egg-info/dependency_links.txt
+mkdocs_document_dates.egg-info/entry_points.txt
+mkdocs_document_dates.egg-info/requires.txt
+mkdocs_document_dates.egg-info/top_level.txt

mkdocs_document_dates-0.1.0/mkdocs_document_dates.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mkdocs_document_dates-0.1.0/mkdocs_document_dates.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin

mkdocs_document_dates-0.1.0/mkdocs_document_dates.egg-info/requires.txt

@@ -0,0 +1 @@
+mkdocs>=1.0.0

mkdocs_document_dates-0.1.0/mkdocs_document_dates.egg-info/top_level.txt

@@ -0,0 +1 @@
+mkdocs_document_dates

mkdocs_document_dates-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mkdocs_document_dates-0.1.0/setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="mkdocs-document-dates",
+    version="0.1.0",
+    author="Aaron Wang",
+    description="一个用于显示文档创建日期和最后修改日期的 MkDocs 插件",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/jaywhj/mkdocs-document-dates",
+    packages=find_packages(),
+    install_requires=[
+        'mkdocs>=1.0.0',
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    entry_points={
+        'mkdocs.plugins': [
+            'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
+        ]
+    },
+    python_requires=">=3.6",
+)