Go to file
Patrick Marsceill 19d6bcf5d3
Merge branch 'master' into v0.3.2
2020-07-22 14:31:25 -04:00
.github Update release-drafter.yml 2020-07-20 17:32:21 -04:00
_includes Merge pull request #359 from totaldebug/fix_https 2020-07-20 17:31:19 -04:00
_layouts Add IDs to target print styles 2020-06-26 15:33:03 -04:00
_sass Fixed css .search-active.main 2020-06-30 20:22:32 +02:00
assets Restored search.rake 2020-06-18 22:39:58 +02:00
bin Update _config.yml with default values 2020-06-25 23:19:24 +02:00
docs Update navigation-structure.md 2020-06-30 13:58:26 -04:00
lib/tasks fix conflicts 2020-06-27 10:02:36 +01: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 Moved config search_tokenizer_separator -> search.tokenizer_separator 2019-12-29 20:08:34 +01: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 2020-04-29 14:05:55 -04:00
Rakefile Restored search.rake 2020-06-18 22:39:58 +02:00
_config.yml Update _config.yml with default values 2020-06-25 23:19:24 +02:00
favicon.ico Favicon file 2019-05-13 16:40:14 -04:00
index.md date fix 2020-05-01 17:32:54 -04:00
just-the-docs.gemspec Update just-the-docs.gemspec 2020-07-20 17:26:49 -04:00
package-lock.json Merge pull request #384 from pmarsceill/dependabot/npm_and_yarn/lodash-4.17.19 2020-07-20 17:37:00 -04:00
package.json Merge pull request #371 from pmarsceill/dependabot/npm_and_yarn/primer/css-15.0.0 2020-07-20 17:33:55 -04:00

README.md

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!




jtd

Installation

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

Usage

View the documentation for usage information.

Contributing

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

Development

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.

License

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