13a1ac2a42
Fix #973 Update the array of excluded directories and files to be: - those that Jekyll excludes by default (since our `exclude` replaces Jekyll's defaults in Jekyll 3) and - the others that the theme previously excluded, but omitting `vendor` – also ones that are no longer in the repo. Excluding `vendor` was preventing HTML compression of the theme docs, since the layout used for compression is in `_layouts/vendor/compress.html`. The change from one-line to multi-line YAML layout for the array of excluded files enhances readability. The addition of explanatory comments supports maintenance. To test the effect of this PR on the theme docs: - Build and serve the theme docs. - Check that the HTML files are now compressed. - Check that the last example of code with line numbers has incorrect formatting. (This PR cannot affect sites that use the theme as a gem or as a remote theme, since we don't include our `_config.yml`.)
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.
Installation
via GitHub Pages remote theme
The quickiest way to use Just The Docs is to use GitHub pages remote theme feature in your _config.yml file:
remote_theme: just-the-docs/just-the-docs
via RubyGems:
Alternatively you can install it as a Ruby Gem.
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
Alternatively, you can run it inside Docker while developing your site
$ docker-compose up
Usage
View the documentation for usage information.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/just-the-docs/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.gemspecandpackage.jsonaccording to semantic versioning.
Design and development principles of this theme:
- As few dependencies as possible
- No build script needed
- First class mobile experience
- Make the content shine
Development
To set up your environment to develop this theme, run bundle install.
A modern devcontainer configuration for VSCode is included.
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.