sphinx builder that outputs jekyll compatible markdown files with frontmatter
Project description
sphinx builder that outputs jekyll compatible markdown files with frontmatter
Please ★ this repo if you found it useful ★ ★ ★
Features
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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1db2bcd5663e548b58495cac02f09a7b1a72efbba7904e34e4b56ae106998ab2 |
|
MD5 | 4710c72fd6786b4010472dcd3ed98e62 |
|
BLAKE2b-256 | 6a5d7bfe4b497899526cc66159001f89659d534d8c40973b9d2634abed095144 |
Hashes for sphinx_jekyll_builder-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af200c0c70afff6278ca0509659359248da4e507040e598dcdeb0ceaf334b3d4 |
|
MD5 | 2d9334784cbfe729eac4e905a474eeaa |
|
BLAKE2b-256 | bffb3be2259b4581b53f64c639a61bf7d75aedb067fece1bd2344c76efd88a40 |