sphinx-jekyll-builder
sphinx builder that outputs jekyll compatible markdown files with frontmatter
Please ★ this repo if you found it useful ★ ★ ★
Features
Installation
pip3 install sphinx-jekyll-builderDependencies
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 jekyllBuild jekyll files with sphinx-build command
cd docs
sphinx-build -M jekyll ./ buildSupport
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!
1 maintainer
Release files for sphinx-jekyll-builder 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-jekyll-builder-0.3.0.tar.gz | 4.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_jekyll_builder-0.3.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 10.4 kB
Release files / sphinx-jekyll-builder-0.3.0.tar.gz
| Download URL | sphinx-jekyll-builder-0.3.0.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ecc0a1821849fc55c4b26e0efb8fb45454904c6900378ebd776f8a74d6e06f7
|
|
BLAKE2b-256 checksum How to use checksums |
755426e8307f9bffe8466d89add5e27eb01dee95b8538b7a804339ea739e2979
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.5rc1
|
Release files / sphinx_jekyll_builder-0.3.0-py2.py3-none-any.whl
| Download URL | sphinx_jekyll_builder-0.3.0-py2.py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
b3b2d46ba49b7d47d8f58077c9ccce928f2cfec6d3fce7738c69f1590c72ebc5
|
|
BLAKE2b-256 checksum How to use checksums |
937412745542895ae9fc9d75805a2d468b869e4e49e3b8aec100dc82e24c058a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.5rc1
|
