mkdocs-interwiki


Namemkdocs-interwiki JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/yourname/mkdocs-interwiki
SummaryDokuWiki-like InterWiki links for MkDocs
upload_time2025-10-08 03:47:04
maintainerNone
docs_urlNone
authorGobidesert
requires_python>=3.8
licenseMIT
keywords mkdocs markdown interwiki dokuwiki plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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`:
```yaml
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):

```yaml
interwiki_extra:
  repo: "other-org/other-repo"
```

## Install

```bash
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 `maps` and `extra` variables
- Per-page `interwiki_extra` overrides
- URL-encoding of `{target}`



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/yourname/mkdocs-interwiki",
    "name": "mkdocs-interwiki",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mkdocs, markdown, interwiki, dokuwiki, plugin",
    "author": "Gobidesert",
    "author_email": "gobidesert.mf@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1a/42/f22d49d67a9011ab2c4e5a6eed793f7172ed4cb7d9fa5070b7f251022f9d/mkdocs-interwiki-0.1.2.tar.gz",
    "platform": null,
    "description": "# mkdocs-interwiki\n\nDokuWiki-like **InterWiki** links for MkDocs.\n\n## Usage\n\nWrite links like:\n```\n\n[[wp>Python|Wikipedia: Python]]\n[[gh>mkdocs/mkdocs|MkDocs on GitHub]]\n[[issue>1234|Bug #1234]]\n\n````\n\nConfigure in `mkdocs.yml`:\n```yaml\nplugins:\n  - interwiki:\n      maps:\n        wp: \"https://en.wikipedia.org/wiki/{target}\"\n        gh: \"https://github.com/{target}\"\n        issue: \"https://github.com/{repo}/issues/{target}\"\n      extra:\n        repo: \"yourorg/yourrepo\"\n````\n\nPer-page override (front matter):\n\n```yaml\ninterwiki_extra:\n  repo: \"other-org/other-repo\"\n```\n\n## Install\n\n```bash\npip install mkdocs-interwiki\n```\n\n## License\n\nMIT\n\n\n# Changelog\n\n## 0.1.1 \u2014 2025-10-05\n- Fix: regex compiled without VERBOSE caused \u201cunbalanced parenthesis\u201d\n- Improve: safer per-page overrides via extension handle instead of re-registering\n\n## 0.1.0 \u2014 2025-10-05\n- Initial public release with DokuWiki-like `[[prefix>Target|Label]]` links\n- Configurable `maps` and `extra` variables\n- Per-page `interwiki_extra` overrides\n- URL-encoding of `{target}`\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "DokuWiki-like InterWiki links for MkDocs",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/yourname/mkdocs-interwiki",
        "Source": "https://github.com/yourname/mkdocs-interwiki",
        "Tracker": "https://github.com/yourname/mkdocs-interwiki/issues"
    },
    "split_keywords": [
        "mkdocs",
        " markdown",
        " interwiki",
        " dokuwiki",
        " plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a42f22d49d67a9011ab2c4e5a6eed793f7172ed4cb7d9fa5070b7f251022f9d",
                "md5": "348e1edf5ad730f973e216ddf98aa240",
                "sha256": "d6891078ba02dda01cd109ddf21976136360040efcf31be6fc87f1938423dfce"
            },
            "downloads": -1,
            "filename": "mkdocs-interwiki-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "348e1edf5ad730f973e216ddf98aa240",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5191,
            "upload_time": "2025-10-08T03:47:04",
            "upload_time_iso_8601": "2025-10-08T03:47:04.044661Z",
            "url": "https://files.pythonhosted.org/packages/1a/42/f22d49d67a9011ab2c4e5a6eed793f7172ed4cb7d9fa5070b7f251022f9d/mkdocs-interwiki-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-08 03:47:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yourname",
    "github_project": "mkdocs-interwiki",
    "github_not_found": true,
    "lcname": "mkdocs-interwiki"
}
        
Elapsed time: 1.45287s