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
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
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry 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.
Metadata
Release files for mkdocs-submodule-edit-uri 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-submodule-edit-uri-1.1.0.tar.gz | 4.0 kB | Without provenance | Details for mkdocs-submodule-edit-uri-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl |
Total release size: 8.2 kB
Release files / mkdocs-submodule-edit-uri-1.1.0.tar.gz
| Download URL | mkdocs-submodule-edit-uri-1.1.0.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d5923bb116fc3ba90bc8d1637828ad68a317ffe8df0421b816031ff172f2dbe1
|
|
BLAKE2b-256 checksum How to use checksums |
88f1db1b8ca6e4db5d19f739df7fb1339d485646213f4ad9b3634bcec101596f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl
| Download URL | mkdocs_submodule_edit_uri-1.1.0-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
555431953747d4abaa3f65fe38deb7c626a6772c42de0423d42c320ac9e284ca
|
|
BLAKE2b-256 checksum How to use checksums |
4fc904410610927738267f23a394c6777056e8214c5eda3a112c4db803ce2ff3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Security for mkdocs-submodule-edit-uri 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.