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申请（联合国）安全代码质量建议