Aviator Jekyll Template

Theme by Cloudcannon

|

Updated: 26 Sep 2023

|

382 Stars

:droplet: API Documentation template for Jekyll

Overview

The AviatorAPI documentation template for Jekyll is a configurable theme that allows users to easily document their API. With a three column layout, full text search, and pre-styled components, Aviator is a responsive and optimized template. It was created by CloudCannon, a Cloud CMS for Jekyll.

Features

• Three column layout
• Fully responsive
• Full text search
• Pre-styled components
• Auto-generated navigation based on category
• Optimized for editing in CloudCannon
• SEO tags
• Google Analytics integration

Installation

To set up the AviatorAPI documentation template, follow these steps:

1. Add your site and author details in _config.yml.
2. Set up a workflow to see your site’s output, either with CloudCannon or Jekyll locally.
3. Install the dependencies with Bundler.
4. Run Jekyll commands through Bundler to ensure you’re using the right versions.

Summary

The AviatorAPI documentation template for Jekyll is a highly versatile theme that allows developers to easily create and manage comprehensive API documentation. With its responsive design, pre-styled components, and full text search functionality, Aviator simplifies the process of organizing and presenting API information. Additionally, its integration with CloudCannon and support for SEO tags and Google Analytics make it a valuable tool for developers looking to document their APIs efficiently and effectively.