Skip to content

yoshizzle/linode-api-docs

 
 

Repository files navigation


The Linode API Docs

This is the new Linode developers site. It provides documentation to complement the APIv4. Currently this software is early-access and is available at developers.linode.com.

Setup

brew install yarn
git clone https://github.com/linode/linode-api-docs.git
cd linode-api-docs
node --version # should be 8.4.0
yarn

Development

Run:

yarn start

to run the prebuild script and start the development server. Connect to localhost:5000 to try it out. Most of the changes you make will be applied on the fly, but you may occasionally find that you have to restart it.

Scripts

The prebuild.js script converts yaml into a js file imported by the app. Prebuild builds a json tree of endpoint indices, endpoints, and methods with the associated resource objects.

License

The Linode Manager's code is distributed under the terms of the BSD 3-clause license. The assets are not licensed for any purpose without prior written approval from Linode, unless otherwise noted.

About

Source for the Linode Developers Site (API v4 Docs)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 93.8%
  • CSS 5.8%
  • HTML 0.4%