Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
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.
[^1]
).. directive::
):code:`print(1)` ...
)see `ref`_
)[#fn]_
)mdinclude
directive to include markdown from md or rst filesmd_parse_relative_links
)=
, H2: -
, H3: ^
, H4: ~
, H5: "
, H6: #
Python 3.6 or newer is required.
pip install sphinx-mdinclude
In your Sphinx conf.py
, add the following lines:
extensions = [
...,
'sphinx_mdinclude',
]
Markdown files with the .md
extension will be loaded and used by Sphinx, similar to
any other .rst
files.
To include Markdown files within other files, use the .. mdinclude:: <filename>
directive. This applies the conversion from Markdown to reStructuredText format.
sphinx-mdinclude
is copyright Hiroyuki Takagi, CrossNox, and Amethyst Reese,
and licensed under the MIT license. I am providing code in this repository to you
under an open source license. This is my personal repository; the license you receive
to my code is from me and not from my employer. See the LICENSE file for details.
FAQs
Markdown extension for Sphinx
We found that sphinx_mdinclude demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.