Qubic's Docs are built using Docusaurus 2 with pnpm
.
To set up the Qubic Docs site locally:
- copy the repo using
git clone git@github.com:a-qubic-world/docs.qubic.world.git
- install dependencies using
pnpm install
- make your changes and updates as needed
- run the local development server using
pnpm start
to test site - build locally via
pnpm build
Note: After cloning the repo to your local machine, all the local development commands are run from within this
docs.qubic.world
directory.
For deployment a push to github is sufficient. A build via netlify is automatically initiated. If the build succeeds, the project is deploayed to the qubic.world server.