跳转到主要内容

此插件允许您配置针对非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 (5.2 kB 查看哈希值)

上传时间: 源代码

构建发行版

autolink_references_mkdocs_plugin-0.2.2-py3-none-any.whl (4.6 kB 查看哈希值)

上传时间: Python 3

支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面