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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66e0b1cf04ed98f16b45c42f4ec45890ea14f3afa8abe9ff3ed848efb5cdf873 |
|
MD5 | a95cba1f5ee81798c730fc1821c2fc9e |
|
BLAKE2b-256 | f52252d83a06627750c6dd99caa978fc0eb4fd6e2c32fcfe697505afd83af1a2 |
Hashes for sphinx_jekyll_builder-0.1.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7085bf2b7ac8e83bfc3b9f957c9e5d37bff73aa0f6dbaae9697319c131b739cb |
|
MD5 | f348403b8438b3a9e0055ae41350f60b |
|
BLAKE2b-256 | 6fdf91018a31082d9f26c9492e27e33a2bfc4f773cc1b99a632f063618911aa3 |