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: # 排除文件列表（支持 unix shell 样式的通配符）
- temp.md # 示例：排除指定文件
- blog/* # 示例：排除 blog 目录下所有文件，包括子目录
- '*/index.md' # 示例：排除所有子目录下的 index.md 文件除了以上基础配置外，插件还提供了丰富的自定义选项，可满足各种个性化需求：
- 日期时间：介绍了文档日期的获取机制以及个性化自定义的方法，支持手动指定每个文档的创建日期和最后更新日期
- 作者：介绍了文档作者的获取机制以及个性化自定义的方法，支持手动指定每个文档的作者信息，比如姓名、链接、头像、邮箱等
- 头像：可手动指定每个作者的头像，支持本地文件路径、URL 路径
- 结构与样式：可在 mkdocs.yml 或 Front Matter 中自由配置插件的显示结构；可通过预置入口快速设置插件样式，比如图标、主题、颜色、字体、动画、分界线等
- 模板变量：可用于优化 sitemap.xml 以便优化站点 SEO
- 最近更新模块：启用最近更新的文档列表（按更新日期倒序排列），这特别适合拥有大量文档的站点，方便读者快速浏览新内容
- 本地化语言：为
timeago和tooltip补充更多本地化语言 - 开发小故事：描述了插件的由来、开发遇到的难点及解决方案、产品设计原则与方向
具体内容参见文档：https://jaywhj.netlify.app/document-dates-zh
- MaterialX，下一代 mkdocs-material，让你继续用熟悉的方式构建漂亮站点。基于
mkdocs-material-9.7.1衍生，取名为X，提供持续的维护与更新（因为 mkdocs-material 将停止维护）
目前已发布的更新，重构和添加了很多新功能，详情见 https://github.com/jaywhj/mkdocs-materialx/releases/
Discord: https://discord.gg/cvTfge4AUy
Wechat:
