1.9 KiB
| layout | title | nav_order |
|---|---|---|
| default | Home | 1 |
{:.img-logo}
A Jekyll theme for documentation
Focus on writing good docs, not building a site for it. Just the docs allows you to create your documentation site with a Jekyll theme that is easily hosted on GitHub pages. {: .fs-6 .fw-300 }
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
- Install the Ruby Gem
$ gem install just-the-docs
# .. or add it to your your Jekyll site’s Gemfile
gem "just-the-docs"
- Add Just the Docs to your Jekyll site’s
config.yml
theme: "just-the-docs"
- Run you local Jekyll server
$ bundle exec jekyll serve
- Point your web browser to http://localhost:4000
About the project
Just the Docs is © 2016 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.