Docs Official

🚀 Galileo Docs

このリポジトリは、Galileoのドキュメントのソースです。ドキュメントの構築と公開にはMintlifyを使用しています。

🚀 クイックスタート

ドキュメントの構築と表示

ドキュメントの構築と公開には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コードを無視します。

✨ 主な機能

• 開発環境の分離：このリポジトリにはdevcontainerが設定されており、VS CodeでDev Containers拡張機能とDockerを使用するか、Code Spaceで実行することで、関連するすべてのツールがインストールされた分離された環境を利用できます。このコンテナには、Mintlify CLIとスペルチェック用のValeがインストールされており、いくつかの推奨拡張機能も用意されています。他に有用な拡張機能を見つけた場合は、devcontainer.jsonファイルに追加してください。

📦 インストール

ドキュメントをローカルで構築するために必要なソフトウェアのインストール手順は以下の通りです。

1. Mintlify CLIをインストールします。

npm install -g mint

2. スペルチェック用にValeをインストールします。

brew install vale

3. MDX2VASTをインストールします。

npm install -g mdx2vast

📚 ドキュメント

貢献について

詳細については、貢献ガイドを参照してください。