跳转至

mkdocs-document-dates

English | 简体中文


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

render

特性

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

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

    构建效率对比： 100个md： 1000个md： 时间复杂度：
    git-revision-date-localized > 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(文档末尾)
      type: date               # 时间类型: date datetime timeago, 默认：date
      exclude:                 # 排除文件列表
        - temp.md                  # 示例：排除指定文件
        - blog/*                   # 示例：排除 blog 目录下所有文件，包括子目录
      date_format: '%Y-%m-%d'  # 日期格式化字符串（例如：%Y年%m月%d日、%b %d, %Y）
      time_format: '%H:%M:%S'  # 时间格式化字符串（仅在 type=datetime 时有效）
      show_author: true        # 作者显示模式: true(头像) text(文本) false(隐藏)
      recently-updated: true   # 是否开启最近更新的数据，默认：false

指定日期时间

优先级：插件会按以下顺序自动获取文档的精确时间信息，会自动缓存创建时间

%%{init: {'theme': 'default', 'themeVariables': {'fontSize': '12px'}}}%%
flowchart LR
    A(Front Matter)
    B(缓存文件)
    C(Git时间戳)
    D(文件时间戳)
    A -.创建时间.-> B -.-> C -.-> D
    A -.最后更新时间.-> C

自定义：可在 Front Matter 中通过以下字段手动指定

  • 创建时间：created, date
  • 最后更新：modified, updated
---
created: 2023-01-01
modified: 2025-02-23
---

指定作者

优先级：插件会按以下顺序自动获取文档的作者信息，会自动解析邮件后做链接

%%{init: {'theme': 'default', 'themeVariables': {'fontSize': '12px'}}}%%
flowchart LR
    A(Front Matter)
    B(Git作者)
    C(site_author)
    D(PC用户名)
    A -.-> B -.-> C -.-> D
    click C "#__tabbed_1_2"

自定义：可在 Front Matter 中通过以下方式配置

1) 配置一个简单作者：通过字段 name

---
name: any-name
email: e-name@gmail.com
---

2) 配置一个完整作者：通过字段 author（字段可选配）

---
author:
  name: jay
  email: jay@qq.com
  avatar: https://xxx.author-avatar-URL.com/xxx.png
  url: https://xxx.website-URL.com/xxx
  description: author description
---

3) 配置多个作者：通过字段 authors（要为多个作者配置完整信息则可在 docs/ 目录下新建配置文件 authors.yml，格式参考 authors.yml）

---
authors:
  - jaywhj
  - dawang
  - sunny
---

支持账户聚合，即同一人的不同邮箱账户可显示为同一作者，可通过在仓库根目录提供一个 .mailmap 文件来配置，详情见 gitmailmap。以下示例将 .local 账户聚合到 junewhj@qq.com：

Aaron <junewhj@qq.com> <aaron@AarondeMacBook-Pro.local>

通过 mkdocs.yml 中的 site_author 属性加载

指定头像

优先级：插件会按以下顺序自动加载作者头像

%%{init: {'theme': 'default', 'themeVariables': {'fontSize': '12px'}}}%%
flowchart LR
    A(Front Matter)
    B(GitHub头像)
    C(字符头像)
    A -.-> B -.-> C

自定义：可在 Front Matter 中通过 自定义作者的 avatar 字段进行自定义

解析 mkdocs.yml 中的 repo_url 属性自动加载

根据作者姓名自动生成，规则如下：
1. 提取 initials：英文取首字母组合，中文取首字
2. 生成动态背景色：基于名字哈希值生成 HSL 颜色

设置插件样式

可通过预置入口快速设置插件样式，比如图标、主题、颜色、字体、动画、分界线等，你只需要找到下方文件取消里面的注释即可：

类别： 位置：
样式与主题 docs/assets/document_dates/user.config.css
属性与功能 docs/assets/document_dates/user.config.js

customization

添加本地化语言

可为 timeago 和 tooltip 补充更多本地化语言：

tooltip

内置语言：en zh zh_TW es fr de ar ja ko ru nl pt

  • 无需手动指定，自动识别（保留了原来的配置项 locale，但已不建议手动配置了）
  • 如语言缺失或内置语言不准确，可在 user.config.js 中，参考 Part 3，自行注册添加，也可以提交 PR 内置

timeago

当设置 type: timeago 时，会启用 timeago.js 来动态地渲染时间，timeago.min.js 内置的语言仅包含 en zh，如需加载其他语言，可以按如下方式配置（2选1）：

  • 在 user.config.js 中，参考 Part 2，自行注册添加
  • 在 mkdocs.yml 中，配置 full 版本的 timeago.full.min.js，一次性重载 所有区域语言
    extra_javascript:
  - assets/document_dates/core/timeago.full.min.js

使用模板变量

你可以在模板中使用如下变量访问文档的元信息：

  • page.meta.document_dates_created
  • page.meta.document_dates_modified
  • page.meta.document_dates_authors
  • config.extra.recently_updated_docs

应用示例：

  • 示例1：为你站点的 sitemap.xml 设置正确的 lastmod，以便搜索引擎能更好的处理 SEO，从而提高你网站的曝光率（下载 sitemap.xml 后覆盖：docs/overrides/sitemap.xml）
  • 示例2：利用模板重新定制插件，你可以完全掌控渲染逻辑，插件只负责提供数据（下载 source-file.html 后覆盖：docs/overrides/partials/source-file.html）

添加最近更新模块

可在任意模板中通过 config.extra.recently_updated_docs 变量获取最近更新的文档数据（按更新时间降序排列），然后自行定制渲染逻辑。

或者参考以下预设模板示例直接使用：

添加到侧边栏导航中

1) 在 mkdocs.yml 中配置开关 recently-updated：

- document-dates:
    ...
    recently-updated:
        limit: 10        # 限制显示的文档数量
        exclude:         # 排除不想显示的文档
        - index.md

2) 下载 nav.html 后覆盖 docs/overrides/partials/nav.html

添加到文档的任意位置

1) 在 mkdocs.yml 中配置开关 recently-updated：

- document-dates:
    ...
    recently-updated:
        limit: 10        # 限制显示的文档数量
        exclude:         # 排除不想显示的文档
        - index.md

2) 在文档中任意位置插入这一行：

<!-- RECENTLY_UPDATED_DOCS -->

recently-updated

如果你只想使用「最近更新模块」，也可以安装单独的插件 mkdocs-recently-updated-docs

其它提示

  1. Git 的 git checkout、git clone 等行为会“重建文件”，从而导致克隆或检出后的分支/文件的原始时间戳丢失。
    • 这是由于 Git 内部原理导致的，Git 存储文件的原理是内容寻址存储（content-addressable storage），不是直接存储，所以当你执行 checkout、clone、merge、rebase 等操作时，Git 会从 object 数据库（或 packfile）里解压出对应 blob， 写入磁盘作为工作区文件，即“重建文件”，从而导致原始时间戳丢失
  2. 为了始终能获取准确的创建时间，采用了单独的文件来存储文档的原始创建时间，位于 docs 目录下（默认是隐藏的），请不要删除：
    • docs/.dates_cache.jsonl，缓存文件
    • docs/.gitattributes，缓存文件的合并机制
  3. 采用了 Git Hooks 机制来自动触发缓存的存储（在每次执行 git commit 时），缓存文件也会随之自动提交，并且 Git Hooks 的安装在插件被安装时也会自动触发，全程无需任何手动干预
    • 请确保是从终端运行 git commit，而不是直接从 VSCode 之类的集成工具中，因为这些工具在集成 Git hooks 时存在 bug
  4. 在 Docker 中运行时，需要先设置 HOME 环境变量，因为安装 Git Hooks 需要一个可写的用户配置目录。例如，在你的 docker-compose.yml 中添加以下配置：
    environment:
  - HOME=/docs
working_dir: /docs
volumes:
  - ./mkdocs:/docs


开发小故事

一个可有可无、微不足道的小插件，没事的朋友可以看看 ^_^

  • 起源：
    • 是因为 git-revision-date-localized ，一个很棒的项目。在2024年底使用时，发现我这本地用不了，因为我的 mkdocs 文档没有纳入 git 管理，然后我就不理解为什么不读取文件时间戳，而要用 git 时间戳，而且文件时间戳更准确，还给作者提了 issue，结果等了一周左右没得到回复（后面作者回复了，人不错，估计他当时在忙没来得及），然后就想，过年期间没啥事，现在 AI 这么火，要不借助 AI 自己试试，就诞生了，诞生于2025年2月
  • 迭代：
    • 开发后，就理解了为什么不采用文件时间戳，因为文件在经过 git checkout 或 clone 时会被重建，从而导致原始时间戳信息丢失，解决办法有很多：
    • 方法 1，采用最近一次 git commit 时间作为文档的最后更新时间，采用首次 git commit 时间作为文档的创建时间，git-revision-date-localized 就是这么做的（这种方式，存在一定的误差且无法在无Git环境中使用）
    • 方法 2，可以提前缓存原始时间，后续读缓存就可以了（时间准确且不依赖任何环境）。缓存的地方，可以是源文档的 Front Matter 中，也可以是单独的文件，我选择了后者。存储在 Front Matter 中非常合理且更简单，但是这样会修改文档的源内容，虽然对正文无任何影响，但是我还是想保证数据的原始性
  • 难点：
    1. 什么时候去读取和存储原始时间？这只是 mkdocs 的一个插件，入口和权限非常有限，mkdocs 提供的只有 build 和 serve，那万一用户不执行 build 或 serve 而直接 commit 呢（比如使用 CI/CD 构建系统时），那就拿不到文件的时间信息了，更别说缓存了
      • 直接说结论：利用 Git Hooks 机制，能在特定的 git 动作发生时触发自定义脚本，比如每次 commit 时
    2. 如何自动安装 Git Hooks？在何时？怎么触发？通过 pip 从 PyPI 安装包并没有标准的 post-install 钩子机制
      • 我的方案：分析了 pip 从 PyPI 安装包的流程，发现通过源码包编译安装时（sdist），会调用 setuptools 来处理，那么可以在 setuptools 的流程中想办法植入安装脚本，即在 setup.py 中添加自定义脚本
    3. 跨平台的 hook 怎么设计？执行 python 脚本，需要明确指定 python 解释器，而用户的 python 环境，因操作系统、python 的安装方式以及配置的不同而各不相同，如何才能保证在所有环境下都能正常运行？
      • 解决办法：考虑过 shell 脚本，但考虑到最终还是要回调 python 脚本，所以还是直接采用 python 脚本更方便。可以在 hook 安装时就检测用户的 python 环境，然后动态设置 hook 的 shebang 行，从而设置正确的 python 解释器
    4. 在多人协作时，如何保证单独的缓存文件不冲突？
      • 我的方案：采用 JSONL（JSON Lines）代替 JSON，配合并集的合并策略 merge=union
    5. 在文档较多时( > 1000 )，如何降低 build 用时？通常每次获取 git 信息都是一次文件 I/O 操作，如果文件较多，就会大大影响构建速度，这让用户没法忍受（比如，为了提高预览速度，git-revision-date-localized 只能通过添加环境变量 enabled: !ENV 在本地禁用自己）
      • 解决办法：减少或固定 I/O 次数 + 使用缓存 + 替换运行效率较低的系统函数
  • 精进：
    • 既然是新开发的插件，那就奔着优秀产品的方向去设计，追求极致的易用性、简洁性、个性化、智能化
      • 易用性：无复杂配置，常用的配置项也就 2-3 条，另外为个性化配置提供了模板
      • 简洁性：无任何不必要的配置，无 Git 依赖，无 CI/CD 配置依赖，无其他包依赖
      • 个性化：可完全自定义插件，完全掌控渲染逻辑，插件只负责提供数据
      • 智能化：智能解析文档时间、作者、头像，智能识别用户语言并自动适配，此外，还有自动安装 Git Hooks、自动缓存、自动 commit 等
      • 兼容性：兼容旧版操作系统和浏览器，如 WIN7、MacOS 10.11、iOS 12、Chrome 63.0.3239
  • 最后的秘密：
    • 编程是业余爱好，我是一名从业八年的市场营销人员（欢迎留言）

评论区