此插件允许您配置针对非GitHub URL的自定义自动链接引用。
项目描述
自动链接引用(MkDocs 插件)
此 MkDocs 插件 查找MkDocs文章中来自Jira、Linear等问题跟踪器的引用,并将它们转换为指向相应平台的链接
入门指南
要安装它,使用 pip
pip install autolink-references-mkdocs-plugin
编辑您的 mkdocs.yml
文件并添加以下几行代码
plugins:
- autolink_references:
autolinks:
- reference_prefix: AF-
target_url: https://linear.com/AF-<num>
- reference_prefix: PROJ-
target_url: https://jiracloud.com/PROJ-<num>
- reference_prefix:此前缀附加一个数字,每次在页面中找到时都会生成一个链接。
- target_url:URL必须包含
<num>
以供引用编号。
示例
例如,您可以编辑 docs/index.md
文件并插入以下票务引用
Changelog:
- AF-100: add new feature.
这将生成预处理的版本
Changelog:
- [AF-100](https://linear.com/AF-100): add new feature.
变更日志
0.2.2 (2023-12-28)
- 允许扩展集和忽略引用样式链接、已链接项和带有 '#' 的 ref_list 情况
0.2.0
- 忽略已链接的引用。
- 将文本
[AF-100]
转换为链接版本并移除括号AF-100
许可
MIT
用❤️构建,作者:Saurabh Kumar
项目详情
关闭
autolink_references_mkdocs_plugin-0.2.2.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | c3eff8563b4332a81f1b694eb3b7b0dca4cab13107b5e7613b148e1809460537 |
|
MD5 | a88ab42d29d7582cb2b0bc8ea316ddfa |
|
BLAKE2b-256 | cb89620f6f1dd6e7d22b18f87fdf1d96e7124bfd39516c625d6ef0ec9bb30bea |
关闭
autolink_references_mkdocs_plugin-0.2.2-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 2eb5cca67bb960295f2cb80ae02ee8b43f2aff37af13b937403d9f5876bdbedc |
|
MD5 | 9cb0db916dbbcbc5cdd2585a61221f28 |
|
BLAKE2b-256 | afd17215765be4057e4697dd5128d267c9591e7529ee66d5a40ee183ac3c9a2d |