CONTRIBUTING.md

Contributing to Simple Layout

Development

npm run build      # build into dist/
npm run test       # run this plugin's tests
npm run typecheck  # type-check this plugin
npm run validate   # check manifest.json
npm run format     # format the code with Prettier

Docs

The docs for this plugin are in docs/ and are published at https://docs.termix.site/plugins/simple-layout. Settings, permissions, services, environment variables and the API reference are made from manifest.json and the @openapi comments in the code, so keep those up to date instead of writing them by hand. See writing docs.