index.md

layout: default
title: Home
nav_order: 1

Focus on writing good documentation

{: .fs-9 }

Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub pages. {: .fs-6 .fw-300 }

Get started now{: .btn .btn-purple .fs-5 .mb-4 .mb-md-0 .mr-2 } View it on GitHub{: .btn .fs-5 }

---

Getting started

Dependancies

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 Jekyll plugins and can run on GitHub Pages standard Jekyll compiler.

Installation

1. Install the Ruby Gem

$ gem install just-the-docs

# .. or add it to your your Jekyll site’s Gemfile
gem "just-the-docs"

2. Add Just the Docs to your Jekyll site’s config.yml

theme: "just-the-docs"

3. Optional: Initialize search data (creates search-data.json)

$ bundle exec just-the-docs rake search:init

3. Run you local Jekyll server

$ jekyll serve

# .. or if you're using a Gemfile (bundler)
$ bundle exec jekyll serve