Skip to content

Reference

mdx.admonition

Module providing the admonition extension for Markdown.

This code is largely based on the original admonition extension provided with Python Markdown.

Original code Copyright Tiago Serafim.

License: BSD

AdmonitionExtension

Bases: Extension

Extension for Admonitions.

Converts markdown admonitions into htmlbook compliant xhtml.

Examples:

The input:

    !!! note "Note title"
        Any number of other indented markdown elements.

will be converted to:

    <div data-type="note">
        <h1>Note title</h1>
        <p>Any number of other indented markdown elements.</p>
    </div>

mdx.checkbox

Module providing the checkbox extension for Markdown.

CheckboxExtension

Bases: Extension

Extension for Checkboxes.

Convert markdown checkboxes to xhtml compliant xml.

Examples:

The input:

    - [ ] unchecked
    - [x] checked

will be converted to:

    <ul class="checklist">
        <li class="unchecked">unchecked</li>
        <li class="checked">checked</li>
    </ul>

mdx.htmlbook

Module providing the htmlbook extension for Markdown.

This code is largely based on the original mdx_outline extension found at: https://github.com/aleray/mdx_outline

Copyright - 2011, 2012 The active archives contributors - 2011, 2012 Michael Murtaugh - 2011, 2012, 2017 Alexandre Leray

This software is released under the modified BSD License.

HtmlBookExtension

Bases: Extension

Extension for HtmlBook.

Wraps all content prior to the first section into preface sections.

mdx.mermaid

Module providing the mermaid generator for the customblocks extension for Markdown.

mermaid_generator(ctx, width='auto', scale=5, background='transparent')

Mermaid generator.

Renders a mermaid diagram into a PNG and includes the image.

mdx.toc

Module providing a htmlbook compliant toc extension for Markdown.

This code is largely based on the original toc extension provided with Python Markdown.

Oringinal code Copyright 2008 Jack Miller

All changes Copyright 2008-2014 The Python Markdown Project

License: BSD

TocExtension

Bases: Extension

Extension for Table of Contents.

Creates a htmlbook compliant table of contents.

Examples:

The input:

    [TOC]

will be converted to:

    <nav data-type="toc">
        <h1>Table of Contents</h1>
        ...
    </nav>

mdx.xhtml

Module providing the xhtml extension for Markdown.

XHTMLExtension

Bases: Extension

Extension for xhtml.

Adds the xhtml namespace ('http://www.w3.org/1999/xhtml') to the top level elements.