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-to-use theme for creating websites. It offers a minimalist design and provides a gem-based approach using a Gemfile. The theme is intended for use with Jekyll and can be easily customized to suit your needs. It also supports deployment on GitHub Pages and provides a smooth mobile experience.
Features:
- Gem-based approach with a Gemfile and just-the-docs gem
- GitHub Pages/Actions workflow for building and publishing the site
- Customizable with options to change versions of just-the-docs and Jekyll, and add plugins
- Provides a first-class mobile experience
- Supports deployment on platforms other than GitHub Pages
- Can be installed as a Ruby Gem without creating a new site
- Comprehensive documentation for usage information
Using the template:
- Click on "use the template" to create a new website using the theme.
- Follow the instructions in the template README file to publish the site on GitHub Pages and preview it locally using Jekyll.
Using RubyGems:
- Add the following line to your Jekyll site's Gemfile:
gem 'just-the-docs'
- Add the following line to your Jekyll site's _config.yml:
theme: just-the-docs
- Run the following command:
bundle install
- Alternatively, you can install it yourself with:
gem install just-the-docs
Summary:
The Just the Docs Theme is a lightweight and user-friendly theme for creating websites. It offers a simplistic design and easy installation process. Whether you choose to use the template or install it as a Ruby Gem, the theme provides flexibility and customization options. With its support for GitHub Pages and mobile responsiveness, it is a convenient choice for building informative and visually appealing websites.
- 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.