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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ecc0a1821849fc55c4b26e0efb8fb45454904c6900378ebd776f8a74d6e06f7 |
|
MD5 | 3e26b7793a20a53261c50e6595929c3f |
|
BLAKE2b-256 | 755426e8307f9bffe8466d89add5e27eb01dee95b8538b7a804339ea739e2979 |
Hashes for sphinx_jekyll_builder-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3b2d46ba49b7d47d8f58077c9ccce928f2cfec6d3fce7738c69f1590c72ebc5 |
|
MD5 | b1f69267a05b174ddaf19636123d7111 |
|
BLAKE2b-256 | 937412745542895ae9fc9d75805a2d468b869e4e49e3b8aec100dc82e24c058a |