| Name | autolink-references-mkdocs-plugin JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | |
| Summary | This plugin allows to configure your own autolink references for non-GitHub URLs. |
| upload_time | 2023-12-28 18:29:06 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
autolinks
mkdocs
regex
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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-<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.
### 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 <num> 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)
Raw data
{
"_id": null,
"home_page": "",
"name": "autolink-references-mkdocs-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "autolinks,mkdocs,regex",
"author": "",
"author_email": "Saurabh Kumar <autolink-references-mkdocs-plugin@saurabh-kumar.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/89/620f6f1dd6e7d22b18f87fdf1d96e7124bfd39516c625d6ef0ec9bb30bea/autolink_references_mkdocs_plugin-0.2.2.tar.gz",
"platform": null,
"description": "# Autolink References (MkDocs Plugin)\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-<num>\n - reference_prefix: PROJ-\n target_url: https://jiracloud.com/PROJ-<num>\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 `<num>` 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 <num> 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 \u2764\ufe0f by [Saurabh Kumar](https://saurabh-kumar.com?ref=autolink-references-mkdocs-plugin)\n",
"bugtrack_url": null,
"license": "",
"summary": "This plugin allows to configure your own autolink references for non-GitHub URLs.",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://github.com/theskumar/autolink-references-mkdocs-plugin/tree/main#readme",
"Source": "https://github.com/theskumar/autolink-references-mkdocs-plugin",
"Tracker": "https://github.com/theskumar/autolink-references-mkdocs-plugin/issues"
},
"split_keywords": [
"autolinks",
"mkdocs",
"regex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afd17215765be4057e4697dd5128d267c9591e7529ee66d5a40ee183ac3c9a2d",
"md5": "9cb0db916dbbcbc5cdd2585a61221f28",
"sha256": "2eb5cca67bb960295f2cb80ae02ee8b43f2aff37af13b937403d9f5876bdbedc"
},
"downloads": -1,
"filename": "autolink_references_mkdocs_plugin-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9cb0db916dbbcbc5cdd2585a61221f28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4613,
"upload_time": "2023-12-28T18:29:05",
"upload_time_iso_8601": "2023-12-28T18:29:05.244604Z",
"url": "https://files.pythonhosted.org/packages/af/d1/7215765be4057e4697dd5128d267c9591e7529ee66d5a40ee183ac3c9a2d/autolink_references_mkdocs_plugin-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb89620f6f1dd6e7d22b18f87fdf1d96e7124bfd39516c625d6ef0ec9bb30bea",
"md5": "a88ab42d29d7582cb2b0bc8ea316ddfa",
"sha256": "c3eff8563b4332a81f1b694eb3b7b0dca4cab13107b5e7613b148e1809460537"
},
"downloads": -1,
"filename": "autolink_references_mkdocs_plugin-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "a88ab42d29d7582cb2b0bc8ea316ddfa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5219,
"upload_time": "2023-12-28T18:29:06",
"upload_time_iso_8601": "2023-12-28T18:29:06.676370Z",
"url": "https://files.pythonhosted.org/packages/cb/89/620f6f1dd6e7d22b18f87fdf1d96e7124bfd39516c625d6ef0ec9bb30bea/autolink_references_mkdocs_plugin-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-28 18:29:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "theskumar",
"github_project": "autolink-references-mkdocs-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autolink-references-mkdocs-plugin"
}
