添加一个 git 仓库
如果您的文档与源代码相关，MkDocs 的 Material 插件提供了将项目仓库的信息作为静态站点的一部分显示的能力，包括 stars 和 forks。此外，还可以显示[最后更新和创建的日期]，以及参与的贡献者。
配置
仓库
为了在您的文档中显示项目仓库的链接，将mkdocs.yml中的repo_url设置为您的仓库的公共 URL，例如：
仓库的链接将在大屏幕上的搜索栏旁边渲染，并作为小屏幕大小的主导航抽屉的一部分。此外，对于托管在GitHub或GitLab上的公共仓库，stars 和 forks 的数量会自动请求并渲染。
GitHub 仓库还包括最新发布的标签。1
仓库名称
MkDocs 将通过检查 URL 来推断源提供者，并尝试自动设置仓库名称。如果你希望自定义名称，请在mkdocs.yml中设置repo_name：
仓库图标
虽然默认的仓库图标是一个通用的 git 图标，但是可以通过在mkdocs.yml中引用有效的图标路径将其设置为主题捆绑的任何图标：
-
输入一些关键词，使用我们的图标搜索找到完美的图标，并点击短代码将其复制到剪贴板：
一些流行的选择：
- –
fontawesome/brands/git - –
fontawesome/brands/git-alt - –
fontawesome/brands/github - –
fontawesome/brands/github-alt - –
fontawesome/brands/gitlab - –
fontawesome/brands/gitkraken - –
fontawesome/brands/bitbucket - –
fontawesome/solid/trash
代码操作
如果[仓库 URL]指向一个有效的GitHub、GitLab或Bitbucket仓库，MkDocs提供了一个名为edit_uri的设置，该设置解析到托管您的文档的子文件夹。
如果你的默认分支名为main，将设置更改为：
确保edit_uri正确配置后，可以添加代码操作按钮。支持两种类型的代码操作：edit和view（仅 GitHub）：
可以通过以下行更改编辑和查看按钮的图标：
-
输入一些关键词，使用我们的图标搜索找到完美的图标，并点击短代码将其复制到剪贴板：
修订版本
以下插件与 MkDocs 的 Material 完全集成，允许显示文档的最后更新和创建日期，以及所有参与的贡献者或作者的链接。
文档日期
git-revision-date-localized插件支持在每页底部添加文档最后更新和创建日期。使用pip安装它：
然后，在mkdocs.yml中添加以下行：
支持以下配置选项：
enabled
默认：true - 此选项指定在构建项目时是否启用插件。如果你想关闭插件，例如本地构建，使用环境变量：
type
默认：date - 要显示的日期的格式。有效值是date、datetime、iso_date、iso_datetime和timeago：
enable_creation_date
默认：false - 启用在每页底部的最后更新日期旁边显示与页面关联的文件的创建日期：
fallback_to_build_date
默认：false - 如果 git 日期不可用，是否应使用构建日期作为后备：
``` yaml
plugins:
- git-revision-date-localized:
fallback_to_build_date: true
```
timeago_now
默认：None - 当type设置为timeago时，此选项将日期限制为现在的一部分，即使在未来：
``` yaml
plugins:
- git-revision-date-localized:
timeago_now: true
```
locale
默认：None - 日期的本地化设置。如果未设置，将使用系统的默认设置：
``` yaml
plugins:
- git-revision-date-localized:
locale: en
```
as_datetime
默认：false - 是否应将日期作为 Python 的datetime对象传递给模板，以便进行进一步处理：
``` yaml
plugins:
- git-revision-date-localized:
as_datetime: true
```
timezone
默认：None - 日期的时区设置。如果未设置，将使用系统的默认设置：
``` yaml
plugins:
- git-revision-date-localized:
timezone: UTC
```
文档贡献者
git-authors插件支持在每页底部添加所有参与的贡献者的链接。使用pip安装它：
然后，在mkdocs.yml中添加以下行：
支持所有文档贡献者的配置选项。