docs.surrealdb.com

是終極雲
明天應用程序的數據庫

發展更容易。 更快地構建。 比例更快。

使用Astro構建的SurroeLDB的文檔。

如果您想做出貢獻，請閱讀貢獻指南。

SurseAldB入門

訪問SurreAldB.com/docs，以開始使用SursteAldB。

學習sursealdB

• SurseAldB大學：https：//surrealdb.com/learn/fundamentals
• AEON的超現實文藝復興時期（相互互補的書）：https：//surrealdb.com/learn/book
• 文檔：https：//surrealdb.com/docs

為文檔做出貢獻

請參閱我們的貢獻指南。

好的第一個問題

我們有一系列好的第一個問題列表，其中包含相對有限範圍的錯誤。這是一個入門，獲得經驗並熟悉我們的貢獻過程的好地方。

安裝

要開始為SurseAldB文檔做出貢獻，請首先使用以下命令安裝所需的軟件包。

該項目將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 +棉布）
• make qa應用安全的代碼質量建議
• make qau申請（聯合國）安全代碼質量建議