mllrjb/spec-api-skeleton

Specification API Skeleton

Specification API Skeleton

Skeleton for design and API documentation.

Contributing

Prerequisites

• mkdocs (requires python)
  • mkdocs-cinder
  • pyvmdown-extensions
• node 4.x

Getting Started

git clone https://github.com/mllrjb/spec-api-skeleton.git

# download
git clone https://github.com/mllrjb/spec-api-skeleton.git
cd spec-api-skeleton

# install deps
npm install
# run server
npm start

You can preview the documentation, changes will automatically refresh.

You can also edit the API definition, which automatically saves changes to app/api/spec.yml.

You can also preview the API docs.

Publishing

# publish documentation to Github Pages
npm run deploy