mirror of
https://github.com/Wcowin/Mkdocs-Wcowin.git
synced 2025-07-20 08:56:35 +00:00
91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
---
|
||
title: 为MKdocs添加文章修订时间戳
|
||
tags:
|
||
- Mkdocs
|
||
comments: false #评论，默认不开启
|
||
---
|
||
|
||
|
||
|
||
参考方法：[git 修订日期本地化](https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#revisioning)
|
||
|
||
利用[git -revision-date-localized插件](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin)添加了对添加上次更新日期和在每个页面底部创建文档的支持
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
pip install mkdocs-git-revision-date-localized-plugin
|
||
```
|
||
|
||
.github/workflows/下的ci.yml增加高亮的几行：
|
||
|
||
```yaml hl_lines="14-15 26-28"
|
||
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：
|
||
```yaml hl_lines="2 3"
|
||
plugins:
|
||
- git-revision-date-localized:
|
||
enable_creation_date: true
|
||
```
|
||
|
||
详细的配置请看：[mkdocs-git-revision-date-localized-plugin](https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html)
|
||
|
||
可选的配置很多：
|
||
```yaml
|
||
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`来禁用它。
|
||
|
||
比较推荐这种方法:
|
||
```yaml hl_lines="2"
|
||
- git-committers:
|
||
enabled: !ENV [CI, false]
|
||
```
|
||
修改enabled的策略，这样就不会每次本地渲染都检查所有文件的git历史记录，渲染速度会明显加快，发布网站时候会正常显示。 |