docs.surrealdb.com
docs.surrealdb.com copied to clipboard
The documentation for SurrealDB, powered by Docusaurus
is the ultimate cloud
database for tomorrow's applications
Develop easier. Build faster. Scale quicker.
The documentation for SurrealDB, built using Docusaurus.
If you want to contribute, then please read the contributing guidelines.
Getting started with SurrealDB
Visit surrealdb.com/docs to get started with SurrealDB.
Contributing to the documentation
Please see our contributing guidelines.
Good First Issues
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.
Installation
To get started with contributing to the SurrealDB documentation, first install the required packages using the following command.
$ pnpm install
Development
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
Building
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