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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4c478b35b1cab1a759688212b7471dc29e29564851cdc326a666fc82ea0a35f |
|
MD5 | 8b1bd6beaeb126ceea54a04806c8899e |
|
BLAKE2b-256 | 6bcbcfaca2094ccb1163e9291fff156afaeb83cda1d8206cb43ad143bee7d575 |
Hashes for sphinx_markdown_builder-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15b032c79579cf5a2656a3ea8cbabc227be477c62d85f5fb43d83be4478e66f3 |
|
MD5 | 6a66e4800fc8f14345b98c68806a3cf1 |
|
BLAKE2b-256 | 71d3683028f061acd16360715e267130695f639bff60ae4dc840ccb535814311 |