llms.txt
このリファレンスサイトでは、llmstxt.org の標準に従った llms.txt ファイルを提供しています。
llms.txt とは
llms.txt は、AI やLLM(Large Language Model)がプロジェクトやライブラリを効率的に理解できるよう設計されたファイル形式です。プロジェクトの重要な情報を構造化されたテキスト形式で提供し、AIアシスタントがより正確で有用なサポートを提供できるようにします。
提供ファイル
GASsma リファレンスでは、以下の2つのファイルを提供しています:
📄 llms.txt(基本版)
- アクセス URL: /llms.txt
- 内容: GASsma の基本的な使用方法、API概要、主要機能の説明
- 対象: 基本的な使い方を知りたい場合や、簡潔な情報が欲しい場合
📄 llms-full.txt(完全版)
- アクセス URL: /llms-full.txt
- 内容: GASsma の完全な技術仕様、エッジケース、実装詳細
- 対象: 詳細な実装や高度な使用法、トラブルシューティングが必要な場合
使用方法
これらのファイルは主に以下の用途で使用されます:
-
AI アシスタントとの連携: Claude や ChatGPT などの AI ツールにファイル内容を提供することで、より正確な GASsma に関するサポートを受けられます
-
プロジェクト理解の促進: 新しい開発者がプロジェクトを理解する際の参考資料として
-
ドキュメント検索: 特定の機能や API について素早く情報を見つけたい場合
ファイル形式の特徴
- マークダウン形式: 人間にも機械にも読みやすい形式
- 構造化された情報: セクション分けされた明確な階層構造
- 実用的なコード例: すぐに使える TypeScript/JavaScript のサンプルコード
- 包括的なリファレンス: API の詳細から使用例まで網羅
更新情報
llms.txt ファイルは GASsma ライブラリの更新に合わせて定期的に更新されます。最新の情報については、常に上記の URL からアクセスしてください。
関連リンク
- llmstxt.org - llms.txt 標準の公式サイト
- GASsma GitHub リポジトリ - ソースコードと最新情報
- NPM パッケージ - パッケージの詳細