sphinx builder that outputs markdown files
Project description
sphinx-markdown-builder
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.
Sphinx >= 1.8
conf.py
from sphinx_markdown_parser.markdown_builder import MarkdownBuilder
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown'
}
def setup(app):
app.add_source_suffix('.md', 'markdown')
app.add_source_parser(MarkdownParser)
Sphinx < 1.8
conf.py
from sphinx_markdown_parser.markdown_builder import MarkdownBuilder
source_suffix = ['.rst', '.md']
source_parsers = {
'.md': MarkdownBuilder
}
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.5.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 520407e000831a7970f45dcd911384beb554407e35117575bde37773f185c1bb |
|
MD5 | 5f64022597ff7f939731f12d80e2eef0 |
|
BLAKE2b-256 | 74c0ec64161e0c14eee3a3279f3d3bc341e3492f798179e7410f7915edd16f85 |
Hashes for sphinx_markdown_builder-0.5.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36e8883f057c9b528ccaa0014df73565c70b8dc42a5440fb0dde452cef7bf46d |
|
MD5 | c8dd18ce873fb2744c3b50312f4d111e |
|
BLAKE2b-256 | c823548eeca50fbaed632bcd09d0a7981665fe87ac9793036285b5f769f73e75 |