OpenGitDocs for Jekyll 🧪

A straightforward documentation site theme for static sites built with Jekyll.

To preview the theme and read the docs, see the site that this repository builds at opengitdocs.com/jekyll.

Features

  • A smart, automatically generated sidebar menu
    • Content ordered by your sections, with nested pages
    • A config option to hide nested pages and show only top level pages
  • Built-in light and dark themes you can switch with a config option
  • Your choice of custom sidebar color and syntax highlighting theme

Theme screenshot

Installation

This theme can be installed as a Gemfile, as a remote theme using GitHub Pages, or by manually copying the theme files. See full instructions here.

Usage

Layouts include:

  • An index, or home page.
  • page to show a list of available documents: see example.
  • post to show a single document: see example.

Configuration

See a sample configuration file and instructions here. OpenGitDocs sets reasonable defaults for missing non-required parameters. Any parameters you set in your site's configuration will override the theme defaults.