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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e3d14e1c58d9007eb8b6a724c62f20a211c147140b990eea48c2ee992b024ff |
|
MD5 | 8229ade44718b1ea651d8b65294581e9 |
|
BLAKE2b-256 | a6d3ca12c35c29a133d93d8fbf13e3dce090dbc31da834229d0e8b1313b3203a |
Hashes for sphinx_jekyll_builder-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdaa021f27d9cce66e16f0ee5dced951b6e0e26fa0b14f54a3cdb36119d2faf5 |
|
MD5 | e845bb4d873544c2d396d9c3707baf2e |
|
BLAKE2b-256 | a34bf607f84696d46722596e53368347e63cbbc73a69c8bdb08966a50c0afa67 |