Skip to main content

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 ★ ★ ★


  • Generates markdown

  • Supports frontmatter

  • Compatible with jekyll

  • Compatible with gatsby


pip3 install sphinx-jekyll-builder



Load extension in configuration.

extensions = [

If using recommonmark, make sure you explicitly ignore the build files as they will conflict with the system.

exclude_patterns = [

Build jekyll files with Makefile

make jekyll

Build jekyll files with sphinx-build command

cd docs
sphinx-build -M jekyll ./ build


Submit an issue


Contribute a screenshot


Review the guidelines for contributing


MIT License

Jam Risser © 2018


Review the changelog


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!

Liberapay receiving Liberapay patrons

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-jekyll-builder-0.3.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

sphinx_jekyll_builder-0.3.0-py2.py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page