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
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63403501fb691c0a1c75b3a4543fd3b226ec1149a974e58d1db4b77463aafffb |
|
MD5 | f5288a3328691827665c803218d62935 |
|
BLAKE2b-256 | e8121679dd6042f2d069852d30d652cb76a1eb16d6cf1730c80d1e31042eac99 |
Hashes for sphinx_jekyll_builder-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5421ec98793d7e0e1a12018379cb54e2c988715e47d384c0eb819de52108d107 |
|
MD5 | 1f974bba8e0194fe8c76cb3bc3fe69a9 |
|
BLAKE2b-256 | 68a3c94f6c7eee56c025d61f924bf516b56e81b014921cadd451a5e38389c8c7 |