Millidocs

Overview

The Millidocs Theme is a simple documentation theme for Jekyll that features the Milligram CSS framework, PrismJS syntax highlighter, and LunrJS search. The theme is designed to be responsive and includes a full-text client-side search feature. It does not have any dependencies with other gems and can be easily built with GitHub.

Features

• Full-text client-side search: Users can easily search for specific keywords or phrases within the documentation.
• Responsive design: The theme is fully responsive and can adapt to different screen sizes and devices.
• Milligram CSS framework: The theme utilizes the lightweight and minimalist Milligram CSS framework for styling.

Installation

To install the Millidocs Theme, follow these steps:

1. Add the following line to your Jekyll site’s Gemfile:

   gem 'millidocs-theme'
   

2. Adapt your Jekyll site config in the _config.yml file:

   theme: millidocs-theme
   

3. Execute the following command to install the theme:

   bundle install
   

Alternatively, you can install the theme directly by running the following command:

gem install millidocs-theme

Summary

The Millidocs Theme is a simple and lightweight documentation theme for Jekyll. It includes features such as a full-text client-side search and responsiveness. The theme is easy to install and use, and it has no dependencies on other gems. It is built with the Milligram CSS framework for a minimalist and stylish design. The theme is available as open source under the MIT License.