sphinx builder that outputs markdown files
Project description
sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use sphinx-jekyll-builder
Features
Generates markdown
Installation
pip3 install sphinx-markdown-builder
Dependencies
Usage
Load extension in configuration.
conf.py
extensions = [
'sphinx_markdown_builder'
]
If using recommonmark, make sure you explicitly ignore the build files as they will conflict with the system.
conf.py
exclude_patterns = [
'build/*'
]
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
Jam Risser © 2018
Changelog
Review the changelog
Credits
Jam Risser - Author
Matthew Brett - doctree2md
Support on Liberapay
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
Add some fuel if you’d like to keep me going!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-markdown-builder-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2f7c5aa8dcd774e9841c1c80b8c5c380c47fa6d16335609b05018a8ce7d7636 |
|
MD5 | 625ff3264a24a86567eab220e91e9794 |
|
BLAKE2b-256 | b55f1fff4ce2519983561b2d4ced32f920639bbbf4d2d7541014d084d6bf348a |
Hashes for sphinx_markdown_builder-0.1.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2458bab3374768146df3ed15fd906e38109f164beaa3ed81f32e6d339e07650b |
|
MD5 | aec7e4667ba77574de9d87f847ed388f |
|
BLAKE2b-256 | 0f8c72782985885fd7f77ab126bdd31197f31fde4c8cbd3f4af53f45fc314ec1 |