JSDocコメントから自動的にAPI文書を生成するTypeScript向けドキュメントジェネレータです。
中辛 の解説
TypeScriptベースのドキュメントジェネレータで、JSDocの@public、@category、@exampleなどのタグをサポートしており、docflow buildコマンド1つで文書サイトを生成できます。AI連携機能により、@generateタグを付けるだけで関数の説明文を自動生成することも可能です。VitePress・Docusaurus・Nextraなどのプラグインが用意されており、既存の文書フレームワークへの組み込みがスムーズです。
こんなリポジトリです
こんなときに便利です
- TypeScriptライブラリの自動API文書化を設定し、JSDocコメントから複数フレームワークの文書サイトを一括生成する場合
- AI統合により関数の説明文を@generateタグで自動生成し、ドキュメント作成の負担を減らしたい場合
主な機能
ほかとの違い
TypeScriptの型情報を完全に解析してドキュメントに反映させ、複数の文書フレームワークに統一されたプラグインで対応できるため、ドキュメント基盤の移行がしやすいです。
このリポジトリの作り方
はじめてですか？ むずかしくありません — 上から順にたどれば、自分の環境で動かして味見できます。
準備するもの
- TypeScript
- Node.js
ギット飯トライで味見
入れるのが面倒で少し不安だったなら — 安全スキャンからインストールまで、ターミナル一行で終わります。
ターミナルに貼り付ければ、ギット飯の安全スキャン → 隔離フォルダへ clone → インストール → 実行方法の案内まで自動です。はじめてでも大丈夫 — この一行だけです。
npx gitbap-try toss/docflow
Node.js さえあれば、インストールなしで動きます · ギット飯トライとは？ →
スター推移 · 7日
確認日時
使いやすさ · まねしやすいか
- ゆるいライセンス
- テストあり
- サンプル集
- 最近の更新
- AGENTS.md
- llms.txt
- テンプレート
更新の情報なし · 2025 年に作成
「Web・Next.js・フルスタック」 こういうリポジトリを毎週受け取りませんか？
毎週月曜の朝、選んだ一膳だけ。広告なし · いつでも解除。
自分のリポジトリですか？ README にギット飯バッジを貼る
[](https://www.gitbap.com/r/toss/docflow)Claude からそのまま使う — ギット飯のつなぎ方
ギット飯を Claude につなぐと、こうしたリポジトリを Claude・Cursor・Codex から直接さがして試せます。
Claude の設定 → コネクタにこのアドレスを貼り付け。
https://www.gitbap.com/api/mcpプラグインを入れると /gitbap-trending·/gitbap-try のスラッシュコマンドで、その場でリポジトリを試せます。Claude Code で下の 2 行を順に実行してください。
/plugin marketplace add jakeparkcolde/gitbap-cowork/plugin install gitbap-cowork@gitbapAI が README をもとに要約しました · 原文を見る