NOTE: This fork is no longer maintained as there is another actively maintained fork https://github.com/liran-funaro/sphinx-markdown-builder, please use it instead.
sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use sphinx-jekyll-builder
Silicon Hills offers premium Node and React develpoment and support services. Get in touch at nuevesolutions.com.
- sphinx-markdown-parser - write markdown inside of docutils & sphinx projects
- Generates markdown
pip3 install sphinxnotes-markdown-builder
Build markdown files with Makefile
make markdown
Build markdown files with sphinx-build
command
cd docs
sphinx-build -M markdown ./ build
Submit an issue
Contribute a screenshot
Review the guidelines for contributing
Jam Risser © 2018
Review the changelog
- Jam Risser - Author
- Matthew Brett - doctree2md
- Shengyu Zhang - Current maintainer