Go to file
Patrick Marsceill 9428b93c3d
Add .ruby-version to gitignore
2020-04-29 14:38:06 -04:00
.github Update ci.yml 2020-04-24 11:44:00 -04:00
_includes Merge branch 'v0.2.9' into default-nav-order 2020-04-27 11:05:46 -04:00
_layouts Update default.html 2020-04-27 14:18:28 -04:00
_sass Merge branch 'improvement/custom-themes' of git://github.com/SgtSilvio/just-the-docs into SgtSilvio-improvement/custom-themes 2020-04-24 15:39:44 -04:00
assets Rm preview js 2020-04-24 15:41:13 -04:00
bin Make spacing consistent 2019-01-14 14:43:16 -05:00
docs Merge branch 'v0.2.9' into default-nav-order 2020-04-27 11:05:46 -04:00
lib/tasks Update 2019-09-12 08:30:29 +02:00
script No longer need this build process 2018-11-15 15:49:41 -05:00
.gitignore Add .ruby-version to gitignore 2020-04-29 14:38:06 -04:00
.prettierignore update prettierignore 2020-04-24 15:55:07 -04:00
.prettierrc lets just use prettier and forget about it :D) 2020-04-24 15:17:14 -04:00
.stylelintrc.json 🎨 Prettier 2020-04-24 19:55:49 +00:00
404.html A nicer 404 2018-12-16 15:24:00 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-10-22 13:07:17 -04:00
Gemfile Initial commit 2017-03-09 13:16:08 -05:00
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
README.md Update README.md 2019-09-10 11:39:30 -04:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
_config.yml Update _config.yml 2020-04-27 13:14:42 -04:00
favicon.ico Favicon file 2019-05-13 16:40:14 -04:00
index.md Update index.md 2020-04-27 13:54:44 -04:00
just-the-docs.gemspec Update just-the-docs.gemspec 2020-04-24 15:22:04 -04:00
package-lock.json 🎨 Prettier 2020-04-24 19:29:01 +00:00
package.json Merge branch 'master' into v0.2.9 2020-04-24 15:28:28 -04:00


Gem version Build status

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!



Add this line to your Jekyll site's Gemfile:

gem "just-the-docs"

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

theme: just-the-docs

And then execute:

$ bundle

Or install it yourself as:

$ gem install just-the-docs


View the documentation for usage information.


Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Submitting code changes:

  • Open a Pull Request
  • Ensure all CI tests pass
  • Await code review
  • Bump the version number in just-the-docs.gemspec and package.json according to semantic versioning.

Design and development principles of this theme:

  1. As few dependencies as possible
  2. No build script needed
  3. First class mobile experience
  4. Make the content shine


To set up your environment to develop this theme, run bundle install.

Your theme is set up just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

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


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