sphinx-mdinclude
Sphinx extension for including or writing pages in Markdown format.
sphinx-mdinclude is a simple Sphinx extension that enables including Markdown documents
from within reStructuredText. It provides the .. mdinclude:: directive, and
automatically converts the content of Markdown documents to reStructuredText format.
sphinx-mdinclude is a fork of m2r and
m2r2, focused only on providing a Sphinx extension.
Features
Basic markdown and some extensions (see below)
inline/block-level raw html
fenced-code block
tables
footnotes ([^1])
Inline- and Block-level rst markups
single- and multi-line directives (.. directive::)
inline-roles (:code:`print(1)` ...)
ref-link (see `ref`)
footnotes ([#fn])
math extension inspired by recommonmark
Sphinx extension
add markdown support for sphinx
mdinclude directive to include markdown from md or rst files
option to parse relative links into ref and doc directives (md_parse_relative_links)
Restrictions
In the rst's directive
|