index.md

layout: default
title: Home
nav_order: 1

Focus on writing your docs, instead of building a website for them.

{: .fs-9 .mb-md-8 :}

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{: .btn .btn-purple .mr-2 } View GitHub{: .btn }

---

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 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. Run you local Jekyll server

$ jekyll serve

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

4. Point your web browser to http://localhost:4000

---

About the project