Documentation

Writing

To write the documentation, just edit (or create a new) .mdx files inside the src folders.

To create a new menu add to the file doczrc.js

Install

1. Navigate to src/docs (Implying that you are at the base of the repository)

2. Run npm install docz -g

3. Run npm install

Development

1. Run npm run dev

Build

1. Run npm run build

2. Run npm run serve to see final build (optinal)

Deploy on GitHub Pages

The project is configured to generate a documentation build file for all commits generated. So as soon as the commit is plunged into the master the deployment is done automatically to GitHub pages

Docz

This documentation is generated with Docz