You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Patrick Marsceill 8340f9acd0
Fix prettier config
3 years ago
.github Update ci.yml 3 years ago
_includes Revert "Mathjax support added" 4 years ago
_layouts Merge pull request #183 from SgtSilvio/improvement/heading-anchors 4 years ago
_sass Merge branch 'master' into v0.2.7-release 4 years ago
assets Update dark-mode-preview.js 4 years ago
bin Make spacing consistent 4 years ago
docs Update 4 years ago
lib/tasks Update 4 years ago
script No longer need this build process 5 years ago
.gitignore Revert "Update .gitignore" 4 years ago
.prettierignore Temporarily add the JS file with liquid tokens so it wont fail 3 years ago
.prettierrc prettier config 3 years ago
.stylelintrc.json Fix prettier config 3 years ago
404.html A nicer 404 5 years ago Create 5 years ago
Gemfile Initial commit 6 years ago
LICENSE.txt Initial commit 6 years ago Update 4 years ago
Rakefile Add rakefile 6 years ago
_config.yml Merge branch 'v0.2.7-release' into mathjax 4 years ago
favicon.ico Favicon file 4 years ago Update 4 years ago
just-the-docs.gemspec Merge pull request #227 from pmarsceill/dependabot/bundler/rake-gte-12.3.1-and-lt-13.1.0 3 years ago
package-lock.json bump stylelint 3 years ago
package.json Fix prettier config 3 years ago

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 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.