Skip to content

maia-score/documentation

Repository files navigation

Maia Score API Documentation

Build Status

This is the main API documentation repository for Maia Score.

To update or maintain this repository

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Compile OpenAPI to Markdown

yarn openapi2md --spec spec/openapi.json --target docs/paths

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.