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.

sphinxnotes-markdown-builder

sphinx builder that outputs markdown files

Please ★ this repo if you found it useful ★ ★ ★

If you want frontmatter support please use sphinx-jekyll-builder

Built by Silicon Hills LLC

Silicon Hills offers premium Node and React develpoment and support services. Get in touch at nuevesolutions.com.

Recommended Projects

• sphinx-markdown-parser - write markdown inside of docutils & sphinx projects

Features

• Generates markdown

Installation

pip3 install sphinxnotes-markdown-builder

Dependencies

• Python 3

Usage

Build markdown files with Makefile

make markdown

Build markdown files with sphinx-build command

cd docs
sphinx-build -M markdown ./ build

Support

Submit an issue

Screenshots

Contribute a screenshot

Contributing

Review the guidelines for contributing

License

MIT License

Jam Risser © 2018

Changelog

Review the changelog

Credits

• Jam Risser - Author
• Matthew Brett - doctree2md
• Shengyu Zhang - Current maintainer