Skip to content

mdx_steroids.wikilink»

The mdx_steroids.wikilink extension parses wikilinks in the style of
the Gollum wiki and
the Github Wiki system.
It will convert links such as [Page name](Page-name.md) to [Page name](/Page-name/.md).
You can specify the start, end and separator strings.

This is now rewritten as a preprocessor, so Wiki Link turns into
Wiki Link and can be processed further.

html_class is currently not used.

Installation»

pip install --user --upgrade git+https://github.com/twardoch/markdown-steroids.git

Docs»

Options»

  steroids.wikilink:
    base_url       : '/'                  # String to append to beginning or URL.
    end_url        : '/'                  # String to append to end of URL.
    html_class     : 'wikilink'           # CSS hook. Leave blank for none.
    space_sep      : '-'                  # String that replaces the space, "-" by default.

Example»

Input Markdown»

This is a Wiki Link of some sorts.

This is a [[Wiki Link]] of some sorts. 

Output HTML»

This is a Wiki Link of some sorts.

<p>This is a <a class="wikilink" href="/Wiki-Link/">Wiki Link</a> of some sorts.</p>

Copyright © 2018 Adam Twardoch adam+github@twardoch.com
Based on original code
Copyright © 2008 Waylan Limberg
Copyright © 2008-2014 The Python Markdown Project
License: BSD 3-clause