{"id":15023088,"url":"https://github.com/theskumar/autolink-references-mkdocs-plugin","last_synced_at":"2025-05-05T22:33:42.675Z","repository":{"id":44763261,"uuid":"304222780","full_name":"theskumar/autolink-references-mkdocs-plugin","owner":"theskumar","description":"mkdocs plugin to provides GitHub like autolink references in Mkdocs.","archived":false,"fork":false,"pushed_at":"2024-08-13T12:52:42.000Z","size":20,"stargazers_count":18,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-12T23:36:59.618Z","etag":null,"topics":["mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theskumar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-15T05:47:46.000Z","updated_at":"2024-10-09T00:30:32.000Z","dependencies_parsed_at":"2023-12-28T19:28:56.168Z","dependency_job_id":"5bfe3528-c92a-4180-8eaa-220f4aea2495","html_url":"https://github.com/theskumar/autolink-references-mkdocs-plugin","commit_stats":{"total_commits":14,"total_committers":3,"mean_commits":4.666666666666667,"dds":0.1428571428571429,"last_synced_commit":"790ca5fc3db87192e252f3e155eda9f46e68fba8"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theskumar%2Fautolink-references-mkdocs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theskumar%2Fautolink-references-mkdocs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theskumar%2Fautolink-references-mkdocs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theskumar%2Fautolink-references-mkdocs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theskumar","download_url":"https://codeload.github.com/theskumar/autolink-references-mkdocs-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252586512,"owners_count":21772306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin"],"created_at":"2024-09-24T19:58:43.414Z","updated_at":"2025-05-05T22:33:42.656Z","avatar_url":"https://github.com/theskumar.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Autolink References (MkDocs Plugin)\n\n[![PyPI - Version](https://img.shields.io/pypi/v/autolink-references-mkdocs-plugin)](https://pypi.org/project/autolink-references-mkdocs-plugin/)\n\n\nThis [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/)\nlook in each MkDocs article for the presence of a reference to tickets from issues\ntrackers like Jira, Linear, etc and convert them to links that point to respective\nplatforms:\n\n\n## Getting started\nTo install it, using `pip`:\n\n```\npip install autolink-references-mkdocs-plugin\n```\n\nEdit your `mkdocs.yml` file and add these few lines of code:\n\n```yaml\nplugins:\n   - autolink_references:\n        autolinks:\n            - reference_prefix: AF-\n              target_url: https://linear.com/AF-\u003cnum\u003e\n            - reference_prefix: PROJ-\n              target_url: https://jiracloud.com/PROJ-\u003cnum\u003e\n```\n\n- __reference_prefix__: This prefix appended by a number will generate a link any time it is found in a page.\n- __target_url__: The URL must contain `\u003cnum\u003e` for the reference number.\n\n### An example\n\nFor example, you could edit the `docs/index.md` file and insert the ticket references like this:\n\n````markdown\n\nChangelog:\n\n- AF-100: add new feature.\n\n````\n\nThis will generate pre-processed to:\n\n```\nChangelog:\n\n- [AF-100](https://linear.com/AF-100): add new feature.\n\n```\n\n## Changelog\n\n### 0.2.2 (2023-12-28)\n\n- Allow extended set for \u003cnum\u003e and ignore ref style links, already linked items, and attr_list cases with '#' before the ref\n\n### 0.2.0\n- Ignore already linked references.\n- Converts text `[AF-100]` to a linked version and removes the brackets `AF-100`\n\n## License\n\nMIT\n\nBuilt with ❤️ by [Saurabh Kumar](https://saurabh-kumar.com?ref=autolink-references-mkdocs-plugin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheskumar%2Fautolink-references-mkdocs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheskumar%2Fautolink-references-mkdocs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheskumar%2Fautolink-references-mkdocs-plugin/lists"}