sphinx-markdown-builder 0.5.3

sphinx builder that outputs markdown files

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

• Python 3

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

MIT 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!