MkDocs Git Revision Date Localized Plugin 使用教程

MkDocs Git Revision Date Localized Plugin 使用教程

mkdocs-git-revision-date-localized-plugin MkDocs plugin to add a last updated date to your site pages 项目地址: https://gitcode.com/gh_mirrors/mk/mkdocs-git-revision-date-localized-plugin

1. 项目目录结构及介绍

mkdocs-git-revision-date-localized-plugin/
├── docs/
│   ├── index.md
│   ├── available-variables.md
│   ├── options.md
│   └── ...
├── mkdocs.yml
├── setup.py
├── README.md
├── LICENSE
└── ...

目录结构介绍

• docs/: 存放项目的文档文件，包括使用说明、配置选项、可用变量等。
• mkdocs.yml: MkDocs 的配置文件，用于配置项目的构建和展示。
• setup.py: Python 项目的安装脚本，用于安装项目所需的依赖。
• README.md: 项目的介绍文件，包含项目的基本信息、安装方法和使用说明。
• LICENSE: 项目的开源许可证文件。

2. 项目的启动文件介绍

mkdocs.yml

mkdocs.yml 是 MkDocs 项目的核心配置文件，用于配置项目的构建和展示。以下是该文件的主要配置项：

site_name: MkDocs Git Revision Date Localized Plugin
nav:
  - Home: index.md
  - Available Variables: available-variables.md
  - Options: options.md
plugins:
  - search
  - git-revision-date-localized

配置项介绍

• site_name: 网站的名称。
• nav: 导航栏的配置，定义了文档的结构和导航路径。
• plugins: 插件配置，这里使用了 search 和 git-revision-date-localized 插件。

3. 项目的配置文件介绍

mkdocs.yml

mkdocs.yml 文件中包含了 MkDocs 项目的所有配置选项，以下是一些关键配置项的介绍：

plugins:
  - git-revision-date-localized:
      type: timeago
      custom_format: "%d %B %Y"
      timezone: Europe/Amsterdam
      locale: en
      fallback_to_build_date: false
      enable_creation_date: true
      exclude:
        - index.md
      enabled: true
      strict: true

配置项介绍

• type: 日期显示的格式，可选值包括 date, datetime, iso_date, iso_datetime, timeago, custom。
• custom_format: 自定义日期格式，使用 Python 的 strftime 格式。
• timezone: 时区设置，默认是 UTC。
• locale: 语言设置，默认是英文。
• fallback_to_build_date: 在没有 Git 的情况下，是否回退到构建日期。
• enable_creation_date: 是否启用创建日期。
• exclude: 排除不需要显示修订日期的页面。
• enabled: 是否启用该插件。
• strict: 是否在日志中显示警告。

通过以上配置，您可以自定义 MkDocs 项目的日期显示格式和行为，以满足不同的需求。

mkdocs-git-revision-date-localized-plugin MkDocs plugin to add a last updated date to your site pages 项目地址: https://gitcode.com/gh_mirrors/mk/mkdocs-git-revision-date-localized-plugin