/docs

Documentation for the Memair API
  1. CSS 59.5%
  2. JavaScript 17.7%
  3. HTML 16.7%
  4. Ruby 6.1%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_authentication updating docs with latest models and python memair package Sep 19, 2018
_documentation adding Pratyusa Ray's bug find Nov 19, 2018
_graphql using new order syntax Nov 16, 2018
_includes updating docs with latest models and python memair package Sep 19, 2018
_layouts adding info about models and graphql examples May 26, 2018
_models adding first and second pages for pagination example Nov 19, 2018
_sass adding proposed models Jun 1, 2018
css adding other end points and fancy js thingy Jan 7, 2018
images having to rename because google is really dumb with image requirements Jul 23, 2018
js updating title to include 'memair' Jul 17, 2018
.gitignore adding other end points and fancy js thingy Jan 7, 2018
.ruby-version bumping ruby version Sep 11, 2018
CNAME converting to docs document Jan 6, 2018
Gemfile actually updating security issue Oct 9, 2018
Gemfile.lock bumping gems Nov 19, 2018
LICENSE copy: Jul 23, 2018
README.md converting to docs document Jan 6, 2018
_config.yml updating docs with latest models and python memair package Sep 19, 2018
favicon.ico fixing favicon Feb 21, 2018
index.html adding other end points and fancy js thingy Jan 7, 2018
search.html converting to docs document Jan 6, 2018

README.md

Aviator

API documentation template for Jekyll. Browse through a live demo. Start documenting your API with this configurable theme.

Aviator template screenshot

Aviator was made by CloudCannon, the Cloud CMS for Jekyll. Find more templates and themes at Jekyll Tips.

Learn Jekyll with step-by-step tutorials and videos at Jekyll Tips.

Features

  • Three column layout
  • Fully responsive
  • Full text search
  • Pre-styled components
  • Auto-generated navigation based on category
  • Optimised for editing in CloudCannon
  • 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 or Jekyll locally).

Develop

Aviator was built with Jekyll version 3.1.6, but should support newer versions as well.

Install the dependencies with Bundler:

$ bundle install

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

$ 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 field in collection configuration in _config.yml.
  • Set the order of the documents inside a collection by setting the position in front matter.

Search

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