Aviator Jekyll Template screenshot

Aviator Jekyll Template

Author Avatar Theme by Cloudcannon
Updated: 26 Sep 2023
382 Stars

:droplet: API Documentation template for Jekyll

Overview:

Aviator is a legacy API documentation template for Jekyll developed by CloudCannon. It provides a three-column layout, full responsiveness, and a search feature. The template is optimized for editing in CloudCannon and comes with pre-styled components and auto-generated navigation based on categories. It also includes SEO tags for better visibility and integration with Google Analytics for tracking website traffic. The template is easy to set up by adding site and author details in the _config.yml file and can be edited using Jekyll commands through Bundler. Aviator supports different collections for organizing content and allows customization of the order of collections and documents. Documentation pages can be excluded from search results by adding excluded_in_search: true to the front matter.

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 for better visibility
  • Integration with Google Analytics

Installation:

To install Aviator, follow these steps:

  1. Add your site and author details in the _config.yml file.
  2. Set up a workflow to see your site’s output either with CloudCannon or Jekyll locally.
  3. Make sure you have Jekyll version 3.7.2 or newer installed.
  4. Install the dependencies with Bundler by running the following command:
    bundle install
    
  5. Use Bundler when running Jekyll commands to ensure the correct versions are used. For example:
    bundle exec jekyll serve
    

Summary:

Aviator is a legacy API documentation template for Jekyll that provides a responsive three-column layout and search functionality. It offers pre-styled components and auto-generated navigation based on categories, making it easy to organize and update documentation pages. The template is optimized for editing in CloudCannon and includes SEO tags and integration with Google Analytics. Installation is straightforward and requires adding site details in the _config.yml file and running Jekyll commands through Bundler. The template supports different collections and allows customization of the order of collections and documents. Additionally, documentation pages can be excluded from search results if needed.