Skip to content

heron-data/docs

Repository files navigation

Documentation

Docs for the Heron Data API built using Docusaurus.

Installation

$ npm install

Local Development

The SPEC_URL environment variable needs to be set before running any of the commands.

$ SPEC_URL=https://staging-app.herondata.io/swagger/ npm start

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

Contributing

If you would like to make a change to our docs, please fork this repository and submit a pull request. It will be reviewed as soon as we can.