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.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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aedd65534b2d5edb0c3cbcc5d6d956149bb1f3a647866572d2cbbe1d1c4d11e8 |
|
MD5 | 6f99837cde85d2b5a3d852c0285e9a88 |
|
BLAKE2b-256 | ff67c12ffabab5ab488509752365834ce45bb193ce225335e61194b3bfbe5ad9 |
Hashes for sphinx_markdown_builder-0.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d285c373a8e1ac8d5b904623b8aeb9467c84958a940c117681302e1b3463a741 |
|
MD5 | 779cc1bf2ece923ea5c3b990409c0ebd |
|
BLAKE2b-256 | d2dcd88aeb7bb12744ee98fd2cf3ac55fe204d5e44ab2dea6723f3d6ce4b9efe |