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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e60f955fe4e1ee4a5bd3d2bacd586ee191545aee33fc3c549c9dd121f6b7815f |
|
MD5 | 459902615cb6c955cab6308e4d1b221a |
|
BLAKE2b-256 | 13b80256af6e5f2bf07efaf0dde027a31dfef70a8dfd4d39e356b8e11ab668bd |
Hashes for sphinx_markdown_builder-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7447cb11bd6ad12becce0b05f3d0231896404a063582b96822ebec786d7233b6 |
|
MD5 | 4997bd472d6e9fe5a5413df61c4da16a |
|
BLAKE2b-256 | 768c470e7a375888f565b534ab03766464a8d94f881384b78517edea2ca33263 |