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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b6637618886406277e2ec5c543acf79c80b65e2e4fd50e98482fb1c5799c399 |
|
MD5 | 3bab4bd1a28120a0bb75c768d996dfda |
|
BLAKE2b-256 | 7604a3f25c3b0a16733b4d308eb451c18dccfe09dd877f851a8fb2756d656e3b |
Hashes for sphinx_markdown_builder-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b667cfc0fc7cf4f87252efa3ac2cdcb2d29abffa8f8db6eff518a64896e9b257 |
|
MD5 | 1c76d3784444989eb91ef77476e45c40 |
|
BLAKE2b-256 | fd40037b8f48ec350d9a25abb7cb081116c3a0ac01c97196856cd6054c157851 |