docs.surrealdb.com

ist die ultimative Wolke
Datenbank für die Anwendungen von morgen

Sich leichter entwickeln. Schneller bauen. Schneller skalieren.

Die Dokumentation für SureLDB, die mit Astro erstellt wurde.

Wenn Sie einen Beitrag leisten möchten, lesen Sie bitte die beitragenden Richtlinien.

Erste Schritte mit Surladbb

Besuchen Sie surladb.com/docs, um mit Surladb zu beginnen.

Lerne surladb

• SureLDB Universität: https://surraldb.com/learn/fundamentals
• Aeons surreale Renaissance (Interatives Buch): https://surraldb.com/learn/book
• Dokumentation: https://surrealldb.com/docs

Beitrag zur Dokumentation

Bitte beachten Sie unsere beitragenden Richtlinien.

Gute erste Ausgaben

Wir haben eine Liste mit guten ersten Problemen, die Fehler enthalten, die einen relativ begrenzten Bereich haben. Dies ist ein großartiger Ort, um loszulegen, Erfahrungen zu sammeln und sich mit unserem Beitragsprozess vertraut zu machen.

Installation

Um mit dem Beitrag zur SureLDB -Dokumentation zu beginnen, installieren Sie zuerst die erforderlichen Pakete mit dem folgenden Befehl.

Dieses Projekt verwendet Bun als Paketmanager. Wenn Sie Bun noch nicht installiert haben, lesen Sie bitte den Installationshandbuch für Ihr Betriebssystem. Es erfordert auch node.js v20.0.0 oder höher.

bun i 

Entwicklung

Der folgende Befehl startet einen lokalen Entwicklungsserver und öffnet ein Browserfenster. Die meisten Änderungen werden live reflektiert, ohne den Server neu starten zu müssen.

 bun dev

Gebäude

Der folgende Befehl erstellt und generiert statische Inhalte in das build -Verzeichnis und kann dann mit jedem Hosting -Service für statische Inhalte bedient werden.

 bun run build

Dateistruktur

Um zur Dokumentation beizutragen, werden die meisten Ihrer Änderungen am src/content -Verzeichnis vorgenommen. Jeder Abschnitt der Dokumentation hat ein eigenes Unterverzeichnis, und jede Seite ist eine MDX -Datei.

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

Linie

Um sicherzustellen, dass die Dokumentation konsistent ist und unserem Style Guide folgt, verwenden wir make qc um nach Linkerfehlern zu überprüfen. Sie können auch make qa verwenden, um die meisten Fehler automatisch zu beheben.

Hier sind die Befehle für einige der gemeinsamen Befehle, die Sie möglicherweise verwenden müssen.

• make install - Installieren Sie Abhängigkeiten, zum ersten Mal oder wenn sie sich ändern
• make dev - einen Entwicklungsserver ausführen
• make build - Erstellen Sie die Website
• make preview - Vorschau zu einem von Ihnen durchgeführten Build
• make qc - die Codequalität überprüfen (FMT + Lint)
• make qa - Vorschläge für sichere Codequalität anwenden
• make qau - Vorschläge für sichere Codequalität anwenden