Skip to main content

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.0 — 2025-10-05

  • Initial public release with DokuWiki-like [[prefix>Target|Label]] links
  • Configurable maps and extra variables
  • Per-page interwiki_extra overrides
  • 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

mkdocs-interwiki-0.1.0.tar.gz (4.3 kB view details)

Uploaded Source

File details

Details for the file mkdocs-interwiki-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs-interwiki-0.1.0.tar.gz
  • Upload date:
  • Size: 4.3 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

Hashes for mkdocs-interwiki-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5c5777215cbabad5d6fc49fbd495c8efd33b87b3260850e6d5515760f4e39641
MD5 bc9dc94c3617165f02463614b8bf62fc
BLAKE2b-256 7844bc159d257db6a66619502ef6e8da018a8e8c45c4a2c38c234de1c391fa2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page