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 代碼。