Focus on writing good documentation
Just the Docs gives your documentation a jumpstart with a responsive Zola theme that is easily customizable.
Getting started
Dependencies
Just the Docs is built for Zola, a blazingly fast static site generator. View the getting started guide for more information. Just the Docs requires no special plugins and can run on GitHub Pages' standard Jekyll compiler.
Quick start: Use as a GitHub Pages remote theme
- Add Just the Docs to your Jekyll site's
_config.yml
as a remote theme
remote_theme: pmarsceill/just-the-docs
You must have GitHub Pages enabled on your repo, one or more Markdown files, and a _config.yml
file. See an example repository
Local installation: Use the gem-based theme
- Install the Ruby Gem
$ gem install just-the-docs
# .. or add it to your your Jekyll site’s Gemfile gem "just-the-docs"
- Add Just the Docs to your Jekyll site’s
_config.yml
theme: "just-the-docs"
- Optional: Initialize search data (creates
search-data.json
)$ bundle exec just-the-docs rake search:init
- Run you local Jekyll server
$ jekyll serve
# .. or if you're using a Gemfile (bundler) $ bundle exec jekyll serve
- Point your web browser to http://localhost:4000
If you're hosting your site on GitHub Pages, set up GitHub Pages and Jekyll locally so that you can more easily work in your development environment.
Configure Just the Docs
About the project
Zola Just the Docs is © 2020 by Jake Swenson.
License
Zola Just the Docs is distributed by an MIT license.
This theme is based off of the Just the Docs
theme by pmarsceill.
Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.
Thank you to the contributors of Just the Docs!
Code of Conduct
Just the Docs is committed to fostering a welcoming community.
View our Code of Conduct on our GitHub repository.