The documentation for SurrealDB, built using Docusaurus.

If you want to contribute, then please read the contributing guidelines.

Visit surrealdb.com/docs to get started with SurrealDB.

Please see our contributing guidelines.

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

To get started with contributing to the SurrealDB documentation, first install the required packages using the following command.

$ pnpm install

The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ pnpm start

The following command builds and generates static content into the build directory, and can then be served using any static contents hosting service.

$ pnpm build