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.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3febadcc1f6a55107c4349caffc54ba4632cf2844677d3505a19e2dae9cc5655 |
|
MD5 | 6f391ac716b80702534c2c52827664ec |
|
BLAKE2b-256 | 4d84d91f038cca9688ab455e0ffcab7f787776dd70e5291cb6372b61a14c7159 |
Hashes for sphinx_jekyll_builder-0.1.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 794eb6094a923fde4478e67fd8dfaab819236a9c70d8a14aaf77fab4136d348d |
|
MD5 | 3ea3d9a415f1f1a056bc9808aea11ebf |
|
BLAKE2b-256 | 9b084dac0ce4048fa3af425b35f54bf2790de18a39d3ad622416e79169009aca |