Skip to main content

This plugin allows to configure your own autolink references for non-GitHub URLs.

Project description

Autolink References (MkDocs Plugin)

This mkdocs plugin look in each MkDocs article for the presence of a reference to tickets from issues trackers like Jira, Linear, etc and convert them to links that point to respective platforms:

Getting started

To install it, using pip:

pip install autolink-references-mkdocs-plugin

Edit your mkdocs.yml file and add these few lines of code:

   - autolink_references:
            - reference_prefix: AF-
            - reference_prefix: PROJ-
  • 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.

An example

For example, you could edit the docs/ file and insert the ticket references like this:


- AF-100: add new feature.

This will generate pre-processed to:


- [AF-100]( add new feature.


0.2.2 (2023-12-28)

  • 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 brackets AF-100



Built with ❤️ by Saurabh Kumar

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page