https://github.com/theskumar/autolink-references-mkdocs-plugin

mkdocs plugin to provides GitHub like autolink references in Mkdocs.
https://github.com/theskumar/autolink-references-mkdocs-plugin

mkdocs mkdocs-plugin

Last synced: 4 days ago
JSON representation

mkdocs plugin to provides GitHub like autolink references in Mkdocs.

• Host: GitHub
• URL: https://github.com/theskumar/autolink-references-mkdocs-plugin
• Owner: theskumar
• License: mit
• Created: 2020-10-15T05:47:46.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-13T12:52:42.000Z (4 months ago)
• Last Synced: 2024-10-30T01:43:43.503Z (about 2 months ago)
• Topics: mkdocs, mkdocs-plugin
• Language: Python
• Homepage:
• Size: 19.5 KB
• Stars: 18
• Watchers: 4
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Autolink References (MkDocs Plugin)

[![PyPI - Version](https://img.shields.io/pypi/v/autolink-references-mkdocs-plugin)](https://pypi.org/project/autolink-references-mkdocs-plugin/)

This [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/)

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:

```yaml

plugins:

   - autolink_references:

        autolinks:

            - reference_prefix: AF-

              target_url: https://linear.com/AF-

            - reference_prefix: PROJ-

              target_url: https://jiracloud.com/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 `` for the reference number.

### An example

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

````markdown

Changelog:

- AF-100: add new feature.

````

This will generate pre-processed to:

```

Changelog:

- [AF-100](https://linear.com/AF-100): add new feature.

```

## Changelog

### 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

### 0.2.0

- Ignore already linked references.

- Converts text `[AF-100]` to a linked version and removes the brackets `AF-100`

## License

MIT

Built with ❤️ by [Saurabh Kumar](https://saurabh-kumar.com?ref=autolink-references-mkdocs-plugin)