如何为MkDocs文档添加指向Git仓库特定部分的源码链接？

方案1：用MkDocs Material主题原生功能 #

这是最简便的实现方式，Material主题自带源码跳转支持：

• 在mkdocs.yml中配置你的Git仓库信息：

repo_url: https://github.com/你的用户名/你的仓库名
repo_name: 你的用户名/你的仓库名

• 启用「View Source」按钮功能：

theme:
  name: material
  features:
    - content.action.view  # 开启页面源码跳转按钮

配置完成后，每个文档页面的右上角会自动出现「View Source」按钮，点击直接跳转到当前文档在Git仓库中的对应文件位置。

方案2：自定义模板实现精准控制 #

如果需要在页面特定位置添加源码链接，可通过修改主题模板实现：

1. 把Material主题的main.html模板复制到项目的docs/templates目录（无此目录则新建）
2. 在模板的目标位置插入以下代码，利用MkDocs内置变量拼接跳转链接：

<a href="{{ config.repo_url }}/blob/你的分支名/{{ page.file.src_path }}">查看源码</a>

其中page.file.src_path会自动获取当前文档的相对路径，替换你的分支名为仓库默认分支（比如main或master）即可。

方案3：第三方插件扩展 #

如果需要更复杂的逻辑（比如关联代码块到对应源码位置），可以使用mkdocs-codeinclude-plugin这类第三方插件，但优先推荐前两种方案，更轻量稳定。

注意：确保Git仓库中的文件路径和MkDocs项目里的文档路径完全匹配，否则跳转会失效。

内容的提问来源于stack exchange，提问作者Shan Dou