rwkiii / Rest-API-Documentation

A website for the REST API Documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

These files comprise Awesome Support API documentation. The endpoint documentation is programmatically, but manually, generated from the API.

Installation

You should have Node, Ruby, and gem installed.

Install Jekyll

Install bundler

Install gem dependencies

bundle install

Setup

Build the endpoint documentation:

ruby regenerate.rb

Run the website locally, and recompile files on change

bundle exec jekyll serve --watch

Open http://0.0.0.0:4000 in your browser to see the site

Notes

Styles use of Foundation v 5.5.3

About

A website for the REST API Documentation

License:GNU General Public License v2.0


Languages

Language:CSS 58.3%Language:HTML 39.8%Language:Ruby 1.3%Language:JavaScript 0.6%