2ashishs/just-the-docs

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

See it in action!

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-remote-theme"
gem "rake"

And add this line to your Jekyll site's _config.yml:

plugins:
  - jekyll-remote-theme

remote-theme: 2ashishs/just-the-docs

And then execute:

$ bundle install

Usage

View the documentation for usage information.

Development

Your theme is set up just like a normal Jekyll site! To test your theme, run

bundle exec jekyll serve --livereload --host <host-ip>

and open your browser at http://<host-ip>:4000. This starts a Jekyll server using your theme.

Add pages, documents, data, etc. like normal to test your theme's contents.

When the theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

The theme is available as open source under the terms of the MIT License.