| name | route |
|---|---|
Documentation |
/documentation |
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
-
Navigate to
src/docs(Implying that you are at the base of the repository) -
Run
npm install docz -g -
Run
npm install
- Run
npm run dev
-
Run
npm run build -
Run
npm run serveto see final build (optinal)
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
This documentation is generated with Docz