MkDocs

• Website

Plugins

Tables

• mkdocs-table-reader-plugin
  • Reads CSV etc. files and renders them as tables
  • Doesn't support inline CSV

Charts

• mkdocs-charts-plugin
  • add plots from data using vegalite

Issues

Nested list items must use 4 spaces

• Based on a bug in Python-Markdown
  • Python-Markdown: Nested lists require 4 spaces of indent

• mkdocs: Incorrect rendering of nested lists
• mkdocs-material: Exceptions in markdown nested list

Solutions:

• Python-Markdown suggests using markdown.markdown(text, tab_length=2) as Python-Markdown configuration, however, MkDocs cannot directly configure Python-Markdown behaviour
• Therefore install the mdx_truly_sane_lists Python-Markdown extension

Install mdx_truly_sane_lists pip package:

pip install mdx_truly_sane_lists

mkdocs.yaml:

markdown_extensions:
  - mdx_truly_sane_lists