Go to file
Patrick Marsceill af3e9f07c7
No longer need this build process
2018-11-15 15:49:41 -05:00
_includes Fix assets 2018-10-22 17:17:46 -04:00
_layouts Add these for a better default jekyll experience 2018-10-24 14:07:02 -04:00
_sass add-in-normalize 2018-11-15 15:35:46 -05:00
assets Add done after creating content 2018-10-23 13:09:23 -04:00
bin Add binary 2017-06-09 10:15:15 -04:00
docs Search documentation - snippet is missing relUrl 2018-11-06 16:50:32 +00:00
lib/tasks Rake fails when dirs dont exist 2018-10-24 16:34:11 -04:00
node_modules Initial commit 2017-03-09 13:16:08 -05:00
script No longer need this build process 2018-11-15 15:49:41 -05:00
.gitignore Initial commit 2017-03-09 13:16:08 -05:00
.stylelintrc.json fix linting / rules 2018-10-25 11:17:10 -04:00
.travis.yml Update .travis.yml 2018-10-25 11:00:40 -04: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 2018-10-26 11:31:38 -04:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
_config.yml Remove this as normalize is now in the _sass dir 2018-11-15 15:49:14 -05:00
index.md Content updates 2018-10-24 14:06:41 -04:00
just-the-docs.gemspec bump version number 2018-10-24 16:39:03 -04:00
package.json Update package.json 2018-10-25 10:54:17 -04:00


Gem version Build status

Just the Docs

A modern, high customizable, 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 setup 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.