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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e653ee1a29bb11cbb0ea5ceb092f0b392c683e98e2b3d2f265b3a45cc29a76b |
|
MD5 | f00d4c2f6a9794115314fef03a32b740 |
|
BLAKE2b-256 | 736fc01f9305519fdf7e95e1d199126ef466c8530982856c54e093b408989890 |
Hashes for sphinx_jekyll_builder-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05fcd3d8d239b23ce5232d4b806729129de496cff60d7b4df82fb631990050ea |
|
MD5 | 4b56571cfbe47b8393ef1acca62d08f8 |
|
BLAKE2b-256 | e56df1f522505ea40e292f5bb91d5f03568a26154148ad1cffcf4545ee7b6855 |