Skip to content

为MKdocs添加文章修订时间戳

img

参考方法：git 修订日期本地化

利用git -revision-date-localized插件添加了对添加上次更新日期和在每个页面底部创建文档的支持

安装

1
pip install mkdocs-git-revision-date-localized-plugin

.github/workflows/下的ci.yml增加高亮的几行：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
name: ci 
on:
  push:
    branches:
      - master 
      - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v4
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v3
        with:
          key: mkdocs-material-${ env.cache_id }
          path: .cache
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-git-revision-date-localized-plugin
      - run: pip install mkdocs-git-authors-plugin
      # - run: pip install mkdocs-rss-plugin           
      - run: pip install mkdocs-material 
      - run: mkdocs gh-deploy --force

配置

然后将以下行添加到mkdocs.yml： 

1
2
3
plugins:
  - git-revision-date-localized:
      enable_creation_date: true

详细的配置请看：mkdocs-git-revision-date-localized-plugin

可选的配置很多： 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
plugins:
  - git-revision-date-localized:
      type: timeago #时间类型
      custom_format: "%d. %B %Y"  # 时间格式
      timezone: Europe/Amsterdam #时区
      locale: en #首选语言
      fallback_to_build_date: false #许回退到git 不可用时mkdocs build执行的时间
      enable_creation_date: true #是否启用创建时间
      exclude:  #排除的页面
          - index.md
      enabled: true #是否启用
      strict: true

温馨提示

对于大型单一的文档库，执行mkdocs serve后的渲染速度明显变慢，这是因为每次渲染都会检查所有文件的git历史记录。如果您不需要这个功能，可以通过将enabled设置为false来禁用它。