此插件允许为非ithub url配置自己的自动链接引用。
autolink-references-mkdocs-plugin的Python项目详细描述
自动链接引用(MkDocs插件)
这个mkdocs plugin 查看每一篇MkDocs文章中是否存在对问题票证的引用 跟踪器如Jira,Linear等,并将它们转换为指向各自的链接 平台:
入门
要安装它,请使用pip
:
pip install autolink-references-mkdocs-plugin
编辑mkdocs.yml
文件并添加以下几行代码:
- reference_prefix:这个前缀加上一个数字,在页面中任何时候都会生成一个链接。在
- target\u url:url必须包含
<num>
作为参考号。在
示例
例如,您可以编辑docs/index.md
文件并插入票证引用,如下所示:
Changelog: - AF-100: add new feature.
这将生成预处理到:
Changelog:
- [AF-100](https://linear.com/AF-100): add new feature.
许可证
麻省理工学院
- 项目
标签: