clayrisser / sphinx-jekyll-builder

sphinx builder that outputs jekyll compatible markdown files with frontmatter

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
• Compatible with gatsby

Installation

pip3 install sphinx-jekyll-builder

Dependencies

• Python 3

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

• 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!

sphinx-jekyll-builder's Issues

Broken by sphinx-markdown-builder=>0.6

Hey, thanks for the software!

I noticed it broke on 6/23 when a new version of sphinx-markdown-builder was released. A fix would either be fixing compatability, or at a minimum pinning to a working version. I'm working around this with armadaproject/armada#2619 locally now.

Can't build using sphinx-build

Trying this for the first time

When I use the sphinx-build command in the docs directory.
Thanks!

sphinx-build -M jekyll ./ _build/jekyll

I get the following errors.

Traceback (most recent call last):
  File "/usr/local/bin/sphinx-build", line 5, in <module>
    from sphinx.cmd.build import main
  File "/usr/local/lib/python3.7/site-packages/sphinx/cmd/build.py", line 17, in <module>
    from typing import Any, IO, List
  File "/usr/local/lib/python3.7/site-packages/typing.py", line 1357, in <module>
    class Callable(extra=collections_abc.Callable, metaclass=CallableMeta):
  File "/usr/local/lib/python3.7/site-packages/typing.py", line 1005, in __new__
    self._abc_registry = extra._abc_registry
AttributeError: type object 'Callable' has no attribute '_abc_registry'

I've followed the setup as described, not sure what the issue is here. Thanks!

styling

Hi,

How to automatically generate styling using the default themes from Sphinx?

Sincerely,
Yaolin