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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 302fbcbdee5fbc4d08db1ebd64943b22c0268a4f6948cb68e7e3332777e9ca03 |
|
MD5 | cb7567feb5df7784d55fb9751d8fb9ef |
|
BLAKE2b-256 | 0e902c81252d8aa0b7cade5e04bc1e014bafc348da9b3067036e1686426acf1a |
Hashes for sphinx_jekyll_builder-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee760f44a7f2888379f20e953ca452eb8c640643ae1980c441146cd9506cc256 |
|
MD5 | 5e9b37e6bc88e157a0ea2fbd56e30143 |
|
BLAKE2b-256 | 3685df173f3d9f2d09dd54eedc64e8b9e0d732ff621cdd5e21ccc85fd3c6f413 |