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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 958c784e37f89c47e59befc7ca33ad51162db57831f16818d8d72490ccd23cfa |
|
MD5 | 4296701c854809855b335248794102dc |
|
BLAKE2b-256 | bd6e1555dc21ffa2c2ff571d9c08d6130c8125bc8ffb051d3803ae646aef9634 |
Hashes for sphinx_jekyll_builder-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82182b4c38b7561e98b5ce97da620110bee3ba41c8351bde052fc476bfde7eb1 |
|
MD5 | e81df664dc7a7b5640146a328e59dd0a |
|
BLAKE2b-256 | 2dc944d0ab086f5dd9d819e533917e668b5c4150a685d2f9425fc894b4cc6103 |