docs.sidingsmedia.com

Documentation service for Sidings Media projects including the API. Built using Docusaurus 2 and an OpenAPI theme from Palo Alto Networks.

Local Development

yarn 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.

Build

yarn build

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

Licence

This repo uses the REUSE standard in order to communicate the correct licence for the file. For those unfamiliar with the standard the licence for each file can be found in one of three places. The licence will either be in a comment block at the top of the file, in a .license file with the same name as the file, or in the dep5 file located in the .reuse directory. If you are unsure of the licencing terms please contact contact@sidingsmedia.com. All files committed to this repo must contain valid licencing information or the pull request can not be accepted.