Expand description
Kotoba Documentation Generator
ソースコードから美しいドキュメントを自動生成するツールです。 HTML、Markdown、JSONなどの形式でドキュメントを出力できます。
§使用方法
# プロジェクトのドキュメントを生成
kotoba docs generate
# 開発サーバーを起動
kotoba docs serve
# ドキュメントを検索
kotoba docs search "function_name"
# ヘルプ表示
kotoba docs --helpModules§
- config
- 設定ファイル管理モジュール
- generator
- ドキュメントジェネレーションモジュール
- parser
- ソースコードパーサーモジュール
- search
- 検索機能モジュール
- server
- ドキュメントサーバーモジュール
- template
- テンプレート処理モジュール
Structs§
- DocItem
- ドキュメント項目
- Docs
Config - ドキュメント設定
- Generate
Result - ドキュメント生成結果
- Search
Config - 検索設定
- Server
Config - サーバー設定
Enums§
- DocType
- ドキュメントの種類
- Docs
Error - ドキュメントジェネレータのエラー型
- Output
Format - 出力形式