sphinx builder that outputs markdown files
Project description
PyPI PyPI - Downloads PyPI - Python Version GitHub stars Liberapay receiving Liberapay patrons
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.parser import MarkdownParser
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.parser import MarkdownParser
source_suffix = ['.rst', '.md']
source_parsers = {
'.md': MarkdownParser
}
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c950c95025b614a16345becd9fc8c7a669600f8f6ab3aa3d399eef814a62b527 |
|
MD5 | c1b3b23c53055ff4efb940952efe1f97 |
|
BLAKE2b-256 | 8fe46a49725cf549323bd0f3c8fe9d871e05de1533a46e78b733882169c90c90 |
Hashes for sphinx_markdown_builder-0.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a67a9a128fb93e1514fe9f6a7c66c2e578c9e31146b94914162220f91eeccfd |
|
MD5 | 0a4795488efa5f054a6818b5f3a64e5b |
|
BLAKE2b-256 | a2b67cb40adda94c54d46fdf85dac5282f0e0f7cb6b1809e4c3e2f7415bc5f3d |