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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aabac72cbfc256d375fb687157642c0e320f4e62e83add09082b1ac20e61730b |
|
MD5 | bdbc6907dbb9d4ca06adae0d751b6f9c |
|
BLAKE2b-256 | 53db816a6c9f7b9bdd122b2be2da09bd5d8946264e80e958b7ff38d7fa60b2dc |
Hashes for sphinx_jekyll_builder-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ded5e7d7e6b13027757d59b08ad0f236696a166d989dcf3cfb166aad653c018 |
|
MD5 | d2bdfeecfea26bebb10fe0a15fc61453 |
|
BLAKE2b-256 | 903dad03b28687b0cf135a196272ed9fd9ebd6e492d6f8e97eb35161195ea71c |