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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d153b91df7035dacb55fb50b2409d96ccbd5350c09e09e425185f89d8aee69b4 |
|
MD5 | 2bc2f5263622ce079ede196ee67886bb |
|
BLAKE2b-256 | 801e15d71d38c7d5d40a176794cf3d46e95d4872c75bc06b363dabcc2697177a |
Hashes for sphinx_jekyll_builder-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 340d165a6e63b6552e760aebd1b4da98efc5511df4628aca5bb50cf6e5dcd11d |
|
MD5 | c79feeeba9a83e61110da29ca032a830 |
|
BLAKE2b-256 | 386647f34d395ac2a536e3a6962e8ed7545394b7a5d1015df77ec4a66d4faa02 |