Maia Score API Documentation

This is the main API documentation repository for Maia Score.

To visit the online documentation please refer to the live site of this document.
To learn more, please visit main site.

To update or maintain this repository

yarn install

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.

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

yarn build

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

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.