Just The Docs
A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Overview
The Just the Docs theme is a simple and easy way to create a new website. It provides a clean and minimal design that focuses on showcasing content. The theme can be used to create sites for various purposes, such as documentation, blogs, or personal websites. It offers customization options and can be easily published on GitHub Pages.
Features
- Clean and minimal design
- Gem-based approach using a Gemfile and the just-the-docs gem
- Built-in GitHub Pages / Actions workflow for easy publishing
- Customizable with options to change versions of just-the-docs and Jekyll, and add plugins
- Mobile-friendly design for a first-class mobile experience
Use the template
To create a new website using the Just the Docs theme, you can use the template provided. Simply click on "use the template" and follow the instructions in the template README file. You don't need to clone or fork the Just the Docs repo unless you want to browse the theme docs locally or contribute to its development.
Use RubyGems
Alternatively, you can install the theme as a Ruby Gem without creating a new site. Add the following line to your Jekyll site's Gemfile:
gem 'just-the-docs'
Then, add this line to your Jekyll site's _config.yml:
theme: just-the-docs
Execute the following command to install the gem:
bundle install
Or you can install it directly:
gem install just-the-docs
Usage
For detailed usage information, refer to the documentation provided with the theme.
Contributing
Contributions such as bug reports, proposals of new features, and pull requests are welcome on the GitHub repository. Contributors are expected to adhere to the Contributor Covenant code of conduct. When submitting code changes, it is recommended to follow the process described in the repository's guidelines.
Summary
The Just the Docs theme offers a simple and minimalistic design for creating websites, particularly for documentation purposes. It can be easily installed and customized using both the template and RubyGems. The theme provides a gem-based approach and includes a built-in GitHub Pages / Actions workflow for easy publishing on GitHub Pages. Overall, Just the Docs is a user-friendly and flexible theme for anyone looking to create a clean and content-focused website.
- Jekyll
Jekyll is a static site generator written in Ruby that allows you to create simple, fast, and secure websites without the need for a database.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- GitHub Pages
Gridsome is a Vue.js-based static site generator that makes it easy to build fast and flexible websites and applications by leveraging modern web technologies like GraphQL, Webpack, and hot reloading
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.