This mkdocs plugin
allows users to convert text such as GHI-123
in their documentation to a
corresponding URL, e.g. https://github.com/myproject/issues/123
. Unlike similar
plugins, argref
takes an argument for each reference that can be utilized
in the URL.
To install it, using pip
:
pip install mkdocs-argref-plugin
Edit your mkdocs.yml
file and add these few lines of code:
plugins:
- argref:
autolinks:
- reference_prefix: GH-
target_url: https://github.com/myname/myproject/issues/<num>
- reference_prefix: PROJ-
target_url: https://jiracloud.com/PROJ-<num>
- reference_prefix: This prefix appended by a number will generate a link any time it is found in a page.
-
target_url: The URL must contain
<num>
for the reference number.
For example, you could edit the docs/index.md
file and insert the ticket references like this:
Changelog:
- GHI-100: add new feature.
This will be converted to:
Changelog:
- [GHI-100](https://github.com/myname/myproject/issues/100): add new feature.
- Fixed bug where only one replacement would be made per page.
- Allow extended set for and ignore ref style links, already linked items, and attr_list cases with '#' before the ref
- Ignore already linked references.
- Converts text
[AF-100]
to a linked version and removes the bracketsAF-100
MIT
Originally built with ❤️ by Saurabh Kumar