2017-03-09 13:16:08 -05:00
---
layout: default
title: Home
nav_order: 1
2019-01-14 14:32:41 -05:00
description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages."
2018-10-24 14:06:41 -04:00
permalink: /
2017-03-09 13:16:08 -05:00
---
2017-06-04 17:50:01 -04:00
# Focus on writing good documentation
2017-11-08 11:23:05 -05:00
{: .fs-9 }
2017-03-09 13:16:08 -05:00
2019-01-14 14:32:41 -05:00
Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages.
2017-06-04 17:50:01 -04:00
{: .fs-6 .fw-300 }
2017-03-24 09:47:37 -04:00
2019-01-06 15:51:30 -05:00
[Get started now ](#getting-started ){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [View it on GitHub ](https://github.com/pmarsceill/just-the-docs ){: .btn .fs-5 .mb-4 .mb-md-0 }
2017-03-09 13:16:08 -05:00
---
## Getting started
2019-01-14 14:18:09 -05:00
2018-10-23 16:29:08 -04:00
### Dependencies
2017-03-09 13:16:08 -05:00
2019-01-14 14:39:40 -05:00
Just the Docs is built for [Jekyll ](https://jekyllrb.com ), a static site generator. View the [quick start guide ](https://jekyllrb.com/docs/ ) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler.
2019-01-14 14:18:09 -05:00
2018-11-16 14:37:28 -05:00
### Quick start: Use as a GitHub Pages remote theme
2019-01-14 14:18:09 -05:00
2018-11-16 14:55:20 -05:00
1. Add Just the Docs to your Jekyll site's `_config.yml` as a [remote theme ](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/ )
2018-11-16 14:37:28 -05:00
```yaml
remote_theme: pmarsceill/just-the-docs
```
2019-01-14 14:32:41 -05:00
< small > You must have GitHub Pages enabled on your repo, one or more Markdown files, and a `_config.yml` file. [See an example repository ](https://github.com/pmarsceill/jtd-remote )</ small >
2018-11-16 14:37:28 -05:00
### Local installation: Use the gem-based theme
2019-01-14 14:18:09 -05:00
2017-03-09 13:16:08 -05:00
1. Install the Ruby Gem
```bash
$ gem install just-the-docs
```
```yaml
# .. or add it to your your Jekyll site’ s Gemfile
gem "just-the-docs"
```
2018-11-16 14:37:28 -05:00
2. Add Just the Docs to your Jekyll site’ s `_config.yml`
2017-03-09 13:16:08 -05:00
```yaml
theme: "just-the-docs"
```
2017-11-08 11:23:05 -05:00
3. _Optional:_ Initialize search data (creates `search-data.json` )
```bash
$ bundle exec just-the-docs rake search:init
```
2017-03-09 13:16:08 -05:00
3. Run you local Jekyll server
```bash
2017-03-24 09:47:37 -04:00
$ jekyll serve
```
```bash
# .. or if you're using a Gemfile (bundler)
2017-03-09 13:16:08 -05:00
$ bundle exec jekyll serve
```
4. Point your web browser to [http://localhost:4000 ](http://localhost:4000 )
2018-11-16 14:37:28 -05:00
### Configure Just the Docs
2019-01-14 14:18:09 -05:00
- [See configuration options ]({{ site.baseurl }}{% link docs/configuration.md %} )
2018-11-16 14:37:28 -05:00
2017-03-09 13:16:08 -05:00
---
## About the project
2017-03-24 09:47:37 -04:00
Just the Docs is © 2017 by [Patrick Marsceill ](http://patrickmarsceill.com ).
2017-03-09 13:16:08 -05:00
### License
Just the Docs is distributed by an [MIT license ](https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt ).
### Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
2018-10-23 14:24:42 -04:00
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 ](https://github.com/pmarsceill/just-the-docs#contributing ).
2017-03-09 13:16:08 -05:00
### Code of Conduct
Just the Docs is committed to fostering a welcoming community.
[View our Code of Conduct ](https://github.com/pmarsceill/just-the-docs/tree/master/CODE_OF_CONDUCT.md ) on our GitHub repository.