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
Generates jekyll
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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edbfe245e73596b7d589cdb42d4e984919107a232cd605db0f2e6195de9f7798 |
|
MD5 | dd8fdf4eb8402a33e2d6da4aae3f6466 |
|
BLAKE2b-256 | 7d8ed44c09d0d2aff976a17f178a1af9906d7ca3bb62244da52adeab63a226e1 |
Hashes for sphinx_jekyll_builder-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9742e543aebf4197373c41b154d7938d190adb1b8b4f09e6b00c45d0a7336cd |
|
MD5 | 8973aeafb9c499d226bdc5639bc477f0 |
|
BLAKE2b-256 | 69699ac3413046c1a838c485c6d3334e6b55ed86d91d487f970a8540dfd709cb |