sphinx builder that outputs markdown files
Project description
PyPI PyPI - Downloads PyPI - Python Version GitHub stars
sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use (sphinx-jekyll-builder)[https://github.com/codejamninja/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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02a4f834c0ac53510b1fc8de808f5b65f4f85585b81fcc7f8fe8d13cf98b268d |
|
MD5 | f56f905fe407cac0dd20d3f1f85b8cab |
|
BLAKE2b-256 | 60972ff15db1dbc6cefc611ed745c1d91eb688c31af77904c47c6837af354c5f |
Hashes for sphinx_markdown_builder-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e83b1c06876750280f31b8b41bf2e1e4332fd471d7103ab7dfb1388433158e3e |
|
MD5 | 3329c8d10a3e58c38bdc20ab204c4dff |
|
BLAKE2b-256 | 1ffd04a33e8c40943fefc100afef2a2eba334e44af3d0ff92cf23267a07fec13 |