This documentation for MiSArch is built using Docusaurus 2, a modern static website generator.
npm i
In both sections of this README, Local Development and Build, the following command will be issued:
npm run update-graphql-docs
update-graphql-docs creates the GraphQL API documentation and for it to work it expects the submodule schemas to be initialized and up-to-date. Because of that we have to execute the following command at first (ideally right after npm i):
git submodule update --init
Note that npm run render-diagrams does not depend on the submodule.
npm run render-diagrams
npm run update-graphql-docs
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.
npm run render-diagrams
npm run update-graphql-docs
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
The page is automatically deployed to https://misarch.github.io on each commit on the main branch