A revisited just-the-docs theme for Jekyll

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.

Go to file

Patrick Marsceill e842498637 Update publish-gem.yml		4 years ago
.github	Update publish-gem.yml	4 years ago
_includes	Merge pull request #334 from CodeSandwich/custom_header_footer	4 years ago
_layouts	Merge pull request #334 from CodeSandwich/custom_header_footer	4 years ago
_sass	I meant auto... oops	4 years ago
assets	Added just-the-docs.collections nav_exclude and search_exclude	4 years ago
bin	Update _config.yml with default values	4 years ago
docs	Update configuration.md	4 years ago
lib/tasks	Merge pull request #379 from SgtSilvio/feature/doc-collections	4 years ago
script	No longer need this build process	6 years ago
.gitignore	Add .ruby-version to gitignore	4 years ago
.prettierignore	update prettierignore	4 years ago
.prettierrc	lets just use prettier and forget about it :D)	4 years ago
.stylelintrc.json	🎨 Prettier	4 years ago
404.html	Ensure pages with nav_exclude are ignored by navigation	4 years ago
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	6 years ago
Dockerfile	run the site locally inside docker container	4 years ago
Gemfile	Initial commit	7 years ago
LICENSE.txt	Initial commit	7 years ago
README.md	run the site locally inside docker container	4 years ago
Rakefile	Restored search.rake	4 years ago
_config.yml	Tweak search to make it less bulky	4 years ago
docker-compose.yml	run the site locally inside docker container	4 years ago
favicon.ico	Favicon file	5 years ago
index.md	Revert this	4 years ago
just-the-docs.gemspec	Bump gem spec	4 years ago
package-lock.json	Merge pull request #451 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-9.2.1	4 years ago
package.json	Update package.json	4 years ago

README.md

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!

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

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/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:

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.

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.