Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clayrisser/sphinx-jekyll-builder
sphinx builder that outputs jekyll compatible markdown files with frontmatter
https://github.com/clayrisser/sphinx-jekyll-builder
builder docs documentation jekyll markdown md python restructuredtext rst sphinx
Last synced: 16 days ago
JSON representation
sphinx builder that outputs jekyll compatible markdown files with frontmatter
- Host: GitHub
- URL: https://github.com/clayrisser/sphinx-jekyll-builder
- Owner: clayrisser
- License: mit
- Created: 2018-11-14T21:19:49.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T06:20:17.000Z (over 1 year ago)
- Last Synced: 2024-10-13T16:42:17.750Z (about 1 month ago)
- Topics: builder, docs, documentation, jekyll, markdown, md, python, restructuredtext, rst, sphinx
- Language: Python
- Homepage: https://codejam.ninja
- Size: 1.04 MB
- Stars: 21
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sphinx-jekyll-builder
[](https://pypi.org/project/sphinx-jekyll-builder)
[](https://pypi.org/project/sphinx-jekyll-builder)
[](https://pypi.org/project/sphinx-jekyll-builder)
[](https://github.com/codejamninja/sphinx-jekyll-builder)
> sphinx builder that outputs jekyll compatible markdown files with frontmatter
Please ★ this repo if you found it useful ★ ★ ★
## Features
* Generates markdown
* Supports frontmatter
* Compatible with [jekyll](https://jekyllrb.com)
* Compatible with [gatsby](https://www.gatsbyjs.org/)
## Installation
```sh
pip3 install sphinx-jekyll-builder
```
## Dependencies
* [Python 3](https://www.python.org)
## Usage
Load extension in configuration.
_conf.py_
```py
extensions = [
'sphinx_jekyll_builder'
]
```
If using [recommonmark](https://github.com/rtfd/recommonmark), make sure you
explicitly ignore the build files as they will conflict with the system.
_conf.py_
```py
exclude_patterns = [
'build/*'
]
```
Build jekyll files with Makefile
```sh
make jekyll
```
Build jekyll files with `sphinx-build` command
```sh
cd docs
sphinx-build -M jekyll ./ build
```
## Support
Submit an [issue](https://github.com/codejamninja/sphinx-jekyll-builder/issues/new)
## Screenshots
[Contribute](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CONTRIBUTING.md) a screenshot
## Contributing
Review the [guidelines for contributing](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CONTRIBUTING.md)
## License
[MIT License](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/LICENSE)
[Jam Risser](https://codejam.ninja) © 2018
## Changelog
Review the [changelog](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CHANGELOG.md)
## Credits
* [Jam Risser](https://codejam.ninja) - Author
* [Matthew Brett](https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py) - doctree2md
## Support on Liberapay
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!
[](https://liberapay.com/codejamninja/donate)
[](https://liberapay.com/codejamninja/donate)