docs

Krmx Documentation

This directory contains the documentation of Krmx. Krmx is a network protocol for realtime multi-user interactions. You can find the live documentation of Krmx here.

The documentation of Krmx uses Nextra.

Running locally

Run the following command to install the required dependencies locally.

cd docs/
npm install

Then, you can start the documentation in development mode with the following command.

npm run dev

To view the documentation, open your browser on http://localhost:3000/krmx.

To edit the documentation you can make changes to the pages/ directory. The local server will update immediately. To find more information on how to write documentation using Nextra you can take a look at the Nextra documentation

Issues

If you find any issues when using or reading through the documentation, then please create a ticket here: krmx/issues.