docs-official

🚀 Galileo文档

本仓库是 Galileo文档 的源码。我们使用 Mintlify 来构建和发布文档。

🚀 快速开始

✨ 贡献代码

更多详细信息请参阅我们的 贡献指南。

📦 开发容器

本仓库配置了开发容器，你可以在安装了开发容器扩展和 Docker 的 VS Code 中运行，也可以在代码空间中运行，这样就能拥有一个安装了所有相关工具的隔离环境。

此容器安装了 Mintlify CLI 以及用于拼写检查的 Vale。此外，它还有一些推荐的扩展。如果你发现其他有用的扩展，请将其添加到 devcontainer.json 文件中。

📦 构建并查看文档

我们使用 Mintlify 来构建和发布文档。

要在本地构建并运行文档，请按以下步骤操作：

1. 安装 Mintlify CLI：

npm install -g mint

2. 运行 Mintlify CLI：

mint dev

🔧 检查损坏链接

在推送更改之前，使用以下命令检查是否存在损坏的链接：

mint broken-links

🔧 检查拼写

本仓库设置了使用 Vale 进行拼写检查。要使用它，请先 安装 Vale：

brew install vale

然后安装 MDX2VAST：

npm install -g mdx2vast

之后，你可以使用以下命令检查拼写：

vale . --glob='!{sdk-api/**/reference/**/*.*}'

此命令会忽略生成的 SDK 代码。