# mkdocs-submodule-edit-uri
[](https://github.com/sondregronas/mkdocs-submodule-edit-uri/)
[](https://github.com/sondregronas/mkdocs-submodule-edit-uri/commit/)
[](https://pypi.org/project/mkdocs-submodule-edit-uri/)
[](https://codecov.io/gh/sondregronas/mkdocs-submodule-edit-uri)
A super simple plugin to convert the edit_uri to match in GitHub submodules, allowing you to store parts of your docs on different repositories
Install using `pip install mkdocs-submodule-edit-uri`
Replaces a given `old` string to a `new` string wherever possible on mkdocs page content.
## Usage
```yaml
repo_url: https://github.com/user/repo
edit_uri: edit/main/docs/
plugins:
- search
- submodule-edit-uri:
modules:
- sub1:
old: https://github.com/user/repo/edit/main/docs/SUBMODULE
new: https://github.com/user/repo-SUBMODULE/edit/main
- sub1-view:
old: https://github.com/user/repo/raw/main/docs/SUBMODULE
new: https://github.com/user/repo-SUBMODULE/raw/main
- sub2-namedoesntmatter:
old: https://github.com/user/repo/edit/main/docs/SUBMODULE2
new: https://github.com/user/repo-SUBMODULE2/edit/main
- sub2-namedoesntmatter-view:
old: https://github.com/user/repo/raw/main/docs/SUBMODULE2
new: https://github.com/user/repo-SUBMODULE2/raw/main
```
> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.
Note: please have the `old` variable be as specific as possible, as to not accidentally replace any other strings that might match the `old` value.
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-submodule-edit-uri",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "mkdocs,markdown,submodules,github,edit_uri",
"author": "",
"author_email": "Sondre Gr\u00f8n\u00e5s <mail@sondregronas.com>",
"download_url": "https://files.pythonhosted.org/packages/88/f1/db1b8ca6e4db5d19f739df7fb1339d485646213f4ad9b3634bcec101596f/mkdocs-submodule-edit-uri-1.1.0.tar.gz",
"platform": null,
"description": "# mkdocs-submodule-edit-uri\n[](https://github.com/sondregronas/mkdocs-submodule-edit-uri/)\n[](https://github.com/sondregronas/mkdocs-submodule-edit-uri/commit/)\n[](https://pypi.org/project/mkdocs-submodule-edit-uri/)\n\n[](https://codecov.io/gh/sondregronas/mkdocs-submodule-edit-uri)\n\nA super simple plugin to convert the edit_uri to match in GitHub submodules, allowing you to store parts of your docs on different repositories\n\nInstall using `pip install mkdocs-submodule-edit-uri`\n\nReplaces a given `old` string to a `new` string wherever possible on mkdocs page content.\n\n## Usage\n```yaml\nrepo_url: https://github.com/user/repo\nedit_uri: edit/main/docs/\n\nplugins:\n - search\n - submodule-edit-uri:\n modules:\n - sub1:\n old: https://github.com/user/repo/edit/main/docs/SUBMODULE\n new: https://github.com/user/repo-SUBMODULE/edit/main\n - sub1-view:\n old: https://github.com/user/repo/raw/main/docs/SUBMODULE\n new: https://github.com/user/repo-SUBMODULE/raw/main\n - sub2-namedoesntmatter:\n old: https://github.com/user/repo/edit/main/docs/SUBMODULE2\n new: https://github.com/user/repo-SUBMODULE2/edit/main\n - sub2-namedoesntmatter-view:\n old: https://github.com/user/repo/raw/main/docs/SUBMODULE2\n new: https://github.com/user/repo-SUBMODULE2/raw/main\n```\n> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n\nNote: please have the `old` variable be as specific as possible, as to not accidentally replace any other strings that might match the `old` value.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A plugin to convert the edit_uri for GitHub submodules",
"version": "1.1.0",
"project_urls": {
"documentation": "https://github.com/sondregronas/mkdocs-submodule-edit-uri",
"funding": "https://github.com/sponsors/sondregronas",
"homepage": "https://github.com/sondregronas/mkdocs-submodule-edit-uri",
"issues": "https://github.com/sondregronas/mkdocs-submodule-edit-uri/issues",
"repository": "https://github.com/sondregronas/mkdocs-submodule-edit-uri"
},
"split_keywords": [
"mkdocs",
"markdown",
"submodules",
"github",
"edit_uri"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4fc904410610927738267f23a394c6777056e8214c5eda3a112c4db803ce2ff3",
"md5": "5c82ec9f8380f08dcc806d4f6a8c4fd2",
"sha256": "555431953747d4abaa3f65fe38deb7c626a6772c42de0423d42c320ac9e284ca"
},
"downloads": -1,
"filename": "mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c82ec9f8380f08dcc806d4f6a8c4fd2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4242,
"upload_time": "2023-10-23T14:59:11",
"upload_time_iso_8601": "2023-10-23T14:59:11.549629Z",
"url": "https://files.pythonhosted.org/packages/4f/c9/04410610927738267f23a394c6777056e8214c5eda3a112c4db803ce2ff3/mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88f1db1b8ca6e4db5d19f739df7fb1339d485646213f4ad9b3634bcec101596f",
"md5": "4ce54d174651600f39c664b948f0dd7b",
"sha256": "d5923bb116fc3ba90bc8d1637828ad68a317ffe8df0421b816031ff172f2dbe1"
},
"downloads": -1,
"filename": "mkdocs-submodule-edit-uri-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4ce54d174651600f39c664b948f0dd7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3988,
"upload_time": "2023-10-23T14:59:14",
"upload_time_iso_8601": "2023-10-23T14:59:14.638623Z",
"url": "https://files.pythonhosted.org/packages/88/f1/db1b8ca6e4db5d19f739df7fb1339d485646213f4ad9b3634bcec101596f/mkdocs-submodule-edit-uri-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-23 14:59:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sondregronas",
"github_project": "mkdocs-submodule-edit-uri",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mkdocs-submodule-edit-uri"
}
JSON
