跳轉到

為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來禁用它。