docs.surrealdb.com

究極のクラウドです
明日のアプリケーションのデータベース

簡単に開発します。 より速く構築します。 より速くスケールします。

Astroを使用して構築されたSurreldbのドキュメント。

貢献したい場合は、貢献ガイドラインをお読みください。

Surreldbを始めます

Surreldb.com/docsにアクセスして、surreldbを始めてください。

surreldbを学びます

• Surreldb大学：https：//surreldb.com/learn/fundamentals
• イオンのシュールレアルルネッサンス（インターナティブブック）：https：//surreldb.com/learn/book
• ドキュメント：https：//surrealdb.com/docs

ドキュメントに貢献します

貢献ガイドラインをご覧ください。

良い最初の問題

比較的限られたスコープを持つバグを含む優れた最初の問題のリストがあります。これは、開始し、経験を積む、貢献プロセスに精通するのに最適な場所です。

インストール

SurreLDBドキュメントに貢献することを始めるには、最初に次のコマンドを使用して必要なパッケージをインストールします。

このプロジェクトは、パッケージマネージャーとしてBunを使用しています。まだBUNをインストールしていない場合は、オペレーティングシステムのインストールガイドをご覧ください。また、node.js v20.0.0以降も必要です。

bun i 

発達

次のコマンドはローカル開発サーバーを起動し、ブラウザウィンドウを開きます。ほとんどの変更は、サーバーを再起動することなくライブで反映されます。

 bun dev

建物

次のコマンドは、静的コンテンツをbuildディレクトリにビルドして生成し、静的コンテンツホスティングサービスを使用して提供できます。

 bun run build

ファイル構造

ドキュメントに貢献するために、変更のほとんどはsrc/contentディレクトリに行われます。ドキュメントの各セクションには独自のサブディレクトリがあり、各ページはMDXファイルです。

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

糸くず

ドキュメントが一貫しており、スタイルガイドに従うことを確認するために、 make qc使用して、糸くずエラーを確認します。 make qaを使用して、ほとんどのエラーを自動的に修正することもできます。

以下は、使用する必要がある一般的なコマンドの一部のコマンドです。

• make install - 依存関係を初めてインストールするか、それらが変更されたとき
• make dev - 開発サーバーを実行します
• make build - ウェブサイトを構築します
• make preview - 作成したビルドをプレビューします
• make qc - コードの品質を確認する（FMT + LINT）
• make qa - 安全なコード品質の提案を適用します
• make qau - 安全なコード品質の提案を適用します