# MkDocs Roamlinks Plugin + Extra
**This is a fork of the original [mkdocs-roamlinks-plugin](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin).**
An MkDocs plugin that simplifies relative linking between documents and convert [[roamlinks]] for [vscode-foam](https://github.com/foambubble/foam) & [obsidian](https://obsidian.md)
## Links
- [PyPi](https://pypi.org/project/mkdocs-roamlinks-plugin-extra)
- [Forked Repository](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin)
## Changes
This plugin adds functionality to convert special characters like `>` to proper links.
## Setup
Install the plugin using pip:
`pip install mkdocs-roamlinks-plugin-extra`
## Usage
Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
- roamlinks_extra
```
Raw data
{
"_id": null,
"home_page": "https://github.com/harttraveller/mkdocs-roamlinks-plugin-extra",
"name": "mkdocs-roamlinks-plugin-extra",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "mkdocs",
"author": "harttraveller",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/24/e3/4a2cf5eab44dbfe1c2d4aba1b337fc5594f59cadf2f1b4092d873f86214f/mkdocs-roamlinks-plugin-extra-0.3.5.tar.gz",
"platform": null,
"description": "# MkDocs Roamlinks Plugin + Extra\n\n**This is a fork of the original [mkdocs-roamlinks-plugin](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin).**\n\nAn MkDocs plugin that simplifies relative linking between documents and convert [[roamlinks]] for [vscode-foam](https://github.com/foambubble/foam) & [obsidian](https://obsidian.md)\n\n## Links\n\n- [PyPi](https://pypi.org/project/mkdocs-roamlinks-plugin-extra)\n- [Forked Repository](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin)\n\n## Changes\n\nThis plugin adds functionality to convert special characters like `>` to proper links.\n\n## Setup\n\nInstall the plugin using pip:\n\n`pip install mkdocs-roamlinks-plugin-extra`\n\n## Usage\n\nActivate the plugin in `mkdocs.yml`:\n\n```yaml\nplugins:\n - roamlinks_extra\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fork of @Jackiexiao mkdocs-roamlinks-plugin package with added support for special chars.",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://github.com/harttraveller/mkdocs-roamlinks-plugin-extra"
},
"split_keywords": [
"mkdocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bc0e990aec461d2e30f6b94a556dbfcbc368ba6d31aa10e461ac53083263be7",
"md5": "83e61e91584f6f99dcbeca9890ab5f2b",
"sha256": "d88bd3d7ca17da2ce0073ee872cad8796042c1ad8185a10b4c6432fc73aa7f78"
},
"downloads": -1,
"filename": "mkdocs_roamlinks_plugin_extra-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83e61e91584f6f99dcbeca9890ab5f2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6972,
"upload_time": "2023-09-27T21:51:49",
"upload_time_iso_8601": "2023-09-27T21:51:49.763813Z",
"url": "https://files.pythonhosted.org/packages/3b/c0/e990aec461d2e30f6b94a556dbfcbc368ba6d31aa10e461ac53083263be7/mkdocs_roamlinks_plugin_extra-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24e34a2cf5eab44dbfe1c2d4aba1b337fc5594f59cadf2f1b4092d873f86214f",
"md5": "aeb293f42acb8a4f7359e2f1aaa77ec0",
"sha256": "85d1e031e8f736c5ecb44c2629eda0b9c994ba64b37d7d521a370f60f719470e"
},
"downloads": -1,
"filename": "mkdocs-roamlinks-plugin-extra-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "aeb293f42acb8a4f7359e2f1aaa77ec0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6013,
"upload_time": "2023-09-27T21:51:51",
"upload_time_iso_8601": "2023-09-27T21:51:51.247773Z",
"url": "https://files.pythonhosted.org/packages/24/e3/4a2cf5eab44dbfe1c2d4aba1b337fc5594f59cadf2f1b4092d873f86214f/mkdocs-roamlinks-plugin-extra-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 21:51:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "harttraveller",
"github_project": "mkdocs-roamlinks-plugin-extra",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "mkdocs-roamlinks-plugin-extra"
}