sphinx builder that outputs jekyll compatible markdown files with frontmatter
Project description
PyPI PyPI - Downloads PyPI - Python Version GitHub stars
sphinx builder that outputs jekyll compatible markdown files with frontmatter
Please ★ this repo if you found it useful ★ ★ ★
Features
Generates jekyll
Installation
pip3 install sphinx-jekyll-builder
Dependencies
Usage
Load 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 jekyll
Build jekyll files with sphinx-build command
cd docs
sphinx-build -M jekyll ./ 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-jekyll-builder-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92f548c0ef2ef683ce3d29f4ee9d05079a53d853620d8d3b42d6ce9868d4092e |
|
MD5 | dafaa24fef30b73f98c834021838f60a |
|
BLAKE2b-256 | f29de70d05b8399cb0602a23dea530b33ec9d10062cc3a8de44c545d46d71f9e |
Hashes for sphinx_jekyll_builder-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56e506bf8bfbf8bc62d5cbf770e834cea55e5090e1885e766691c6452f99f086 |
|
MD5 | 16c2b55f54925090bdfe5bed075d49cc |
|
BLAKE2b-256 | 68b42a4a8fec4a26d1e2b664c9ea8de74b1022235bc2a4bb10ddb23a6bea8740 |