Tekyll

screenshot of Tekyll

Jekyll template for documentation

Overview

Coo template is a modified version of the Jekyll theme Chirpy, designed specifically for creating online documentation. This template is based on the Chirpy starter template and provides an easy-to-use solution for creating documentation websites. By utilizing Coo, users can quickly set up their online documentation and begin writing and organizing their content.

Features

  • Jekyll Theme: Coo is a fork of the popular Jekyll theme Chirpy.
  • Modified for Documentation: Coo comes with modifications to make it suitable for creating online documentation.
  • Easy Installation: The template can be easily installed by cloning the repository and setting up the necessary dependencies.
  • Make Integration: Coo recommends using the software Make to automate the building of the documentation site.
  • Optional npm Package: Users can use the Prettier package to automatically format Markdown files.
  • Configuration File: The _config.yml file can be customized to fit the specific needs of the documentation site.
  • Home Page Customization: Users can create an index.html file to customize the home page of their site.
  • Content Organization: The template provides a doc/ directory for organizing the textual contents of the documentation.
  • Summary File: A YAML file called _data/summary.yml helps structure the document and determine the order of sections.

Summary

The Coo template is a modified version of the Chirpy Jekyll theme specifically designed for creating online documentation. It offers a range of features including easy installation, content organization, and customization options. By using Coo, users can quickly set up their documentation site and focus on creating high-quality content.