DokuWiki-like InterWiki links for MkDocs
Project description
mkdocs-interwiki
DokuWiki-like InterWiki links for MkDocs.
Usage
Write links like:
[[wp>Python|Wikipedia: Python]]
[[gh>mkdocs/mkdocs|MkDocs on GitHub]]
[[issue>1234|Bug #1234]]
Configure in mkdocs.yml:
plugins:
- interwiki:
maps:
wp: "https://en.wikipedia.org/wiki/{target}"
gh: "https://github.com/{target}"
issue: "https://github.com/{repo}/issues/{target}"
extra:
repo: "yourorg/yourrepo"
Per-page override (front matter):
interwiki_extra:
repo: "other-org/other-repo"
Install
pip install mkdocs-interwiki
License
MIT
Changelog
0.1.1 — 2025-10-05
- Fix: regex compiled without VERBOSE caused “unbalanced parenthesis”
- Improve: safer per-page overrides via extension handle instead of re-registering
0.1.0 — 2025-10-05
- Initial public release with DokuWiki-like
[[prefix>Target|Label]]links - Configurable
mapsandextravariables - Per-page
interwiki_extraoverrides - URL-encoding of
{target}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mkdocs-interwiki-0.1.1.tar.gz.
File metadata
- Download URL: mkdocs-interwiki-0.1.1.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.32.5 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5686806f9b4f53568a1241ea766f4fa9b5ce99d2056583c840aa528c8a729e68
|
|
| MD5 |
629e66f261edfd24c5875ee2453bd095
|
|
| BLAKE2b-256 |
50a01dc8167753ddbcbfbe5331b5760e2d92e83efb5ff0e1cbb80883bbf8dde9
|