just-the-docs/index.md

layout	title	nav_order
default	Home	1

Focus on writing documentation, not building a website for it.

{: .mt-4 .mt-md-0 :}

Just the Docs gives your documentation a home 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

Just the Docs is © 2017 by Patrick Marsceill.

License

Just the Docs is distributed by an MIT license.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.

Code of Conduct

Just the Docs is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.