ドキュメント
ソース: github.com/tuist/tuist/tree/main/docs
目的#
このドキュメントサイトでは、Tuistの製品およびコントリビューター向けドキュメントを公開しています。VitePressで構築されています。
貢献方法#
ローカル環境のセットアップ#
bash
cd docs
mise install
mise run dev
オプションの生成データ#
ドキュメントには一部の生成データを埋め込んでいます:
- CLIリファレンスデータ:
mise run generate-cli-docs
これらはオプションです。ドキュメントはこれらのデータなしでも表示されるため、生成コンテンツを更新する必要がある場合のみ実行してください。
ProjectDescription APIリファレンスは、projectdescription.tuist.dev でDocCサイトとして別途公開されています。ローカルでビルドするには、リポジトリのルートから mise run docs:project-description を実行してください。