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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ade5e0604b716b13123ea5794b788d3a2cc5280043dd89e5a1ef6e5833a68339 |
|
MD5 | 5515bda5b2caf47b7434a34b7f02cccc |
|
BLAKE2b-256 | 9e7fac8c954276cb0da6eb091d97c84bcab51710cce13c7c0d528f5150326409 |
Hashes for sphinx_markdown_builder-0.1.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edc1c8fd7617a11668eaac8d7e943bdd32bea61c95dc3a1b07ba21628c4f81f5 |
|
MD5 | 5d10b6e60e6618dfeb0c759b6280b5be |
|
BLAKE2b-256 | 9ee8b0266d485bff5c776db71494a1f4888b433625b8aad445e78288030181bd |