Title

Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages.

Get started now View it on GitHub

Getting started

Dependencies

Just the Docs is built for Jekyll, a static site generator. View the quick start guide for more information. Just the Docs requires no special plugins and can run on GitHub Pages’ standard Jekyll compiler. The Jekyll SEO Tag plugin is included by default (no need to run any special installation) to inject SEO and open graph metadata on docs pages. For information on how to configure SEO and open graph metadata visit the Jekyll SEO Tag usage guide.

Quick start: Use as a GitHub Pages remote theme

1. Add Just the Docs to your Jekyll site’s _config.yml as a remote theme

remote_theme: just-the-docs/just-the-docs

You must have GitHub Pages enabled on your repo, one or more Markdown files, and a _config.yml file. See an example repository