sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use sphinx-jekyll-builder
- Generates markdown
pip3 install sphinx-markdown-builder
Load extension in configuration.
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)
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
Submit an issue
Contribute a screenshot
Review the guidelines for contributing
Jam Risser © 2018
Review the changelog
- Jam Risser - Author
- Matthew Brett - doctree2md
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!