sphinx builder that outputs jekyll compatible markdown files with frontmatter
Please ★ this repo if you found it useful ★ ★ ★
pip3 install sphinx-jekyll-builderLoad extension in configuration.
conf.py
extensions = [
'sphinx_jekyll_builder'
]If using recommonmark, make sure you explicitly ignore the build files as they will conflict with the system.
conf.py
exclude_patterns = [
'build/*'
]Build jekyll files with Makefile
make jekyllBuild jekyll files with sphinx-build command
cd docs
sphinx-build -M jekyll ./ buildSubmit 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!
