docs.surrealdb.com

es la mejor nube
base de datos para las aplicaciones del mañana

Desarrollar más fácil. Construir más rápido. Escala más rápido.

La documentación para SurreLDB, construida usando Astro.

Si desea contribuir, lea las pautas contribuyentes.

Comenzando con SurrealDB

Visite SurrealDB.com/docs para comenzar con SurrealDB.

Aprender SURLELDB

• Universidad SurrealDb: https://surrealDb.com/learn/fundamentals
• Renacimiento surrealista de Aeon (libro interativo): https://surrealDb.com/learn/book
• Documentación: https://surrealDb.com/docs

Contribuyendo a la documentación

Consulte nuestras pautas contribuyentes.

Buenos primeros problemas

Tenemos una lista de buenos primeros problemas que contienen errores que tienen un alcance relativamente limitado. Este es un gran lugar para comenzar, ganar experiencia y familiarizarse con nuestro proceso de contribución.

Instalación

Para comenzar a contribuir a la documentación de SurreLAlDB, primero instale los paquetes requeridos utilizando el siguiente comando.

Este proyecto usa BUN como nuestro Administrador de paquetes. Si aún no ha instalado BUN, consulte la guía de instalación para su sistema operativo. También requiere Node.js V20.0.0 o superior.

bun i 

Desarrollo

El siguiente comando inicia un servidor de desarrollo local y abre una ventana del navegador. La mayoría de los cambios se reflejan en vivo sin tener que reiniciar el servidor.

 bun dev

Edificio

El siguiente comando construye y genera contenido estático en el directorio build , y luego se puede servir utilizando cualquier servicio de alojamiento de contenido estático.

 bun run build

Estructura de archivo

Para contribuir a la documentación, la mayoría de sus cambios se realizarán en el directorio src/content . Cada sección de la documentación tiene su propio subdirectorio, y cada página es un archivo MDX.

src/
    assets/
    components/
    content/
        doc-surrealdb/
        doc-surrealql/
        doc-surrealist/
        ...
    layouts/
    pages/
    styles/
    util/ 

Pelusa

Para garantizar que la documentación sea consistente y seguimos nuestra guía de estilo, utilizamos make qc para verificar los errores de pelusa. También puede usar make qa para corregir automáticamente la mayoría de los errores.

Aquí están los comandos para algunos de los comandos comunes que puede necesitar usar.

• make install : instalar dependencias, primera vez o cuando cambian
• make dev - ejecutar un servidor de desarrollo
• make build - construir el sitio web
• make preview - Vista previa una compilación que realizó
• make qc - Verifique la calidad del código (FMT + Lint)
• make qa : aplique sugerencias de calidad de código seguro
• make qau - Aplicar (un) sugerencias de calidad de código seguro