mkdocs-document-dates

English | 简体中文

新一代用于显示文档确切创建日期、最后更新日期、作者、头像、邮箱等信息的 MkDocs 插件

特性

• 始终显示文档的精确元信息，且适用于任何环境（无 Git、Git 环境、Docker 容器、所有 CI/CD 构建系统等）
• 支持列表显示最近更新的文档（按更新日期降序排列）
• 支持在 Front Matter 中手动指定日期和作者
• 支持多种日期格式（date、datetime、timeago）
• 支持多种作者模式（头像、文本、隐藏）
• 支持手动配置作者的姓名、链接、头像、邮箱等
• 灵活的显示位置（顶部或底部）
• 优雅的样式设计（完全可定制）
• 多语言支持，本地化支持，智能识别用户语言，自动适配

• 极致的构建效率：O(1)，无需设置环境变量 !ENV 来区别运行

  构建速度对比：	100个md：	1000个md：	时间复杂度：
  git-revision-date-localized git-authors	＞ 3 s	＞ 30 s	O(n)
  document-dates	＜ 0.1 s	＜ 0.15 s	O(1)

安装

pip install mkdocs-document-dates

配置

在你的 mkdocs.yml 中添加插件即可：

plugins:
  - document-dates

或者，完整配置：

plugins:
  - document-dates:
      position: top            # 显示位置: top(标题后) bottom(文档末尾), 默认: top
      type: date               # 日期类型: date datetime timeago, 默认: date
      exclude:                 # 排除文件列表
        - temp.md                  # 示例：排除指定文件
        - blog/*                   # 示例：排除 blog 目录下所有文件，包括子目录
      date_format: '%Y-%m-%d'  # 日期格式化字符串（例如: %Y年%m月%d日、%b %d, %Y）