Welcome

Markdown extensions for mkdocs.

Autodoc Extension

A markdown extension is provided for automatically documenting python code.

Modules are referred to as follows:

# A Top Level Module

@[jetblack_markdown]

# A Package

@[jetblack_markdown.autodoc]

# A function

@[jetblack_markdown.autodoc:makeExtension]

# A class

@[jetblack_markdown.autodoc.metadata:PropertyDescriptor]

mkdocs integration

Add the extension under markdown_extensions.

...

markdown_extensions:
  - jetblack_markdown.autodoc:
      ignore_all: false
      ignore_inherited: true
      prefer_docstring: true
      follow_module_tree: False

extra_css:
    - css/custom.css

...

Customizing

All the rendering is done with jinja2 templates. Start by copying the current templates from jetblack_markdown/templates and specify the template_folder in the mkdocs.yml.

Latex2MathML Extension

A markdown extension is provided for converting LaTex style math formula to MathML. This uses the latex2mathml package.

An inline formula looks like: $x = \frac{- b \pm \sqrt{b^{2} - 4 a c}}{2 a}$ .

A block looks like:

x = \frac{- b \pm \sqrt{b^{2} - 4 a c}}{2 a}

The outer <math> tag has the HTML class "latex2mathml".

mkdocs integration

This site was generated using mkdocs and the following config:

site_name: jetblack-markdown

docs_dir: documentation
site_dir: docs

markdown_extensions:
  - admonition
  - codehilite
  - jetblack_markdown.autodoc:
      ignore_all: false
      ignore_inherited: true
      prefer_docstring: true
      follow_module_tree: False
  - jetblack_markdown.latex2mathml:

extra_css:
    - css/custom.css