use your own jinja2 template for index.md and other files

[ctb]

ribbity uses jinja2 templating to build Markdown pages from GitHub issues.

It comes with several default templates: index.md, examples.md, and labels.md, as well as _generic_issue.md and _generic_label.md; you can see the default templates here.

You can override any of these templates by creating a directory site-templates/ within the directory where you're running ribbity, and putting an updated version of the template in that directory (with the same name). Templates in the site-templates/ directory will be read before the templates included with ribbity, and so will override them.

This is how projects like ribbity docs customize the main page, by providing their own index.md template.

Example templates

You can see some example templates at the following projects:

• sourmash examples
• ribbity docs

The jinja2 templating language

Please see the jinja2 template designer docs for information on jinja2 templates.