Skip to content

sphinx builder that outputs jekyll compatible markdown files with frontmatter

License

Notifications You must be signed in to change notification settings

clayrisser/sphinx-jekyll-builder

Repository files navigation

sphinx-jekyll-builder

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

  • Generates markdown
  • Supports frontmatter
  • Compatible with jekyll
  • Compatible with gatsby

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

MIT License

Jam Risser © 2018

Changelog

Review the changelog

Credits

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

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •