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
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e9eeadad676681f414e5fc8e1a358d32bf69a226f136b62f3504085b9f7b444 |
|
MD5 | 681a2ddc5414f9d5902aa6549af2d1eb |
|
BLAKE2b-256 | 7f47352d33fd343d75987423120b31ad1f4c0ce7911e9542c9e91e188839c514 |
Hashes for sphinx_jekyll_builder-0.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 908f61e7815fe49a298446e8ae874d135a125cab166b8d8f2df37add1a7dcdae |
|
MD5 | b06fc65a72e558dabb5b1763da4564fe |
|
BLAKE2b-256 | 7c00fb9efd276e0a7b12924303dab6faca79238c14483e7e9224a3e22453ce21 |