https://github.com/CloudCannon/aviator-jekyll-template

:droplet: API Documentation template for Jekyll
https://github.com/CloudCannon/aviator-jekyll-template

jekyll jekyll-template jekyll-theme

Last synced: about 2 months ago
JSON representation

:droplet: API Documentation template for Jekyll

• Host: GitHub
• URL: https://github.com/CloudCannon/aviator-jekyll-template
• Owner: CloudCannon
• License: mit
• Created: 2015-01-28T02:49:52.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T20:39:50.000Z (about 1 year ago)
• Last Synced: 2024-10-12T19:21:37.160Z (2 months ago)
• Topics: jekyll, jekyll-template, jekyll-theme
• Language: SCSS
• Homepage: https://tangerine-lemon.cloudvent.net
• Size: 3.17 MB
• Stars: 374
• Watchers: 15
• Forks: 185
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Aviator [ LEGACY TEMPLATE NO LONGER MAINTAINED ]

API documentation template for Jekyll. Browse through a [live demo](https://tangerine-lemon.cloudvent.net/).

Start documenting your API with this configurable theme.

![Aviator template screenshot](images/_screenshot.png)

Aviator was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at [CloudCannon Academy](https://learn.cloudcannon.com/).

[![Deploy to CloudCannon](https://buttons.cloudcannon.com/deploy.svg)](https://app.cloudcannon.com/register#sites/connect/github/CloudCannon/aviator-jekyll-template)

## Features

* Three column layout

* Fully responsive

* Full text search

* Pre-styled components

* Auto-generated navigation based on category

* Optimised for editing in [CloudCannon](http://cloudcannon.com/)

* SEO tags

* Google Analytics

## Setup

1. Add your site and author details in `_config.yml`.

2. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).

## Develop

Aviator was built with [Jekyll](http://jekyllrb.com/) version 3.7.2, but should support newer versions as well.

Install the dependencies with [Bundler](http://bundler.io/):

~~~bash

$ bundle install

~~~

Run `jekyll` commands through Bundler to ensure you're using the right versions:

~~~bash

$ bundle exec jekyll serve

~~~

## Editing

Aviator is already optimised for adding, updating and removing documentation pages in CloudCannon.

### Usage

* Each section is a different collection, this helps organise your content.

* Set the order of the collections with the position_number field in collection configuration in `_config.yml`.

* Set the order of the documents inside a collection by setting the position_number in front matter.

### Search

* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results.