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

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:

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.