typedoc
TypeDoc (TypeScript API ドキュメントジェネレーター) リファレンス。 typedoc.json、TSDoc タグ、CLI オプション、entryPoints、 テーマ (default / markdown)、プラグイン開発、 TSDoc / JSDoc コメントから HTML / Markdown ドキュメント生成。
- Installs
- 95
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/fandhe-ai/agent-reference-skills --skill typedoc- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads typedoc automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
TypeDoc リファレンス
TypeDoc (TypeScript ドキュメントジェネレーター) の全 API ドキュメントを網羅したスキル。 ユーザーのタスクに応じて適切な README.md を読み、そこから個別ファイルへ辿ること。
ディレクトリ構成
skills/typedoc/
SKILL.md
references/
getting-started/
README.md
installation.md
node-module-api.md
browser-bundle.md
guides/
README.md
doc-comments.md
jsdoc-support.md
external-documents.md
declaration-references.md
tags-block/
README.md
author.md
category.md
defaultValue.md
deprecated.md
document.md
example.md
expand.md
group.md
import.md
inline-type.md
license.md
mergeModuleWith.md
module.md
param.md
privateRemarks.md
property.md
remarks.md
returns.md
see.md
since.md
sortStrategy.md
summary.md
template.md
throws.md
typeParam.md
typescript-tags.md
tags-modifier/
README.md
abstract.md
alpha.md
beta.md
class.md
enum.md
event.md
eventProperty.md
expand.md
experimental.md
function.md
hidden.md
hideconstructor.md
ignore.md
inline.md
interface.md
internal.md
namespace.md
overload.md
override.md
packageDocumentation.md
primaryExport.md
private.md
protected.md
public.md
readonly.md
reexport.md
sealed.md
useDeclaredType.md
virtual.md
tags-inline/
README.md
include.md
inheritDoc.md
label.md
link.md
options/
README.md
comments.md
configuration.md
input.md
organization.md
other.md
output.md
validation.md
themes/
README.md
built-in.md
community-themes.md
plugins/
README.md
community-plugins.md
development/
README.md
overview.md
plugin-development.md
custom-themes.md
internationalization.md
api/
README.md
application.md
converter.md
events.md
options-api.md
reflections.md
renderer.md
serialization.md
types.md
samples/
README.md
basic-cli-usage.md
typedoc-json-config.md
programmatic-api.md
doc-comments.md
grouping-and-categories.md
external-documents.md
plugin-authoring.md
monorepo-entry-points.md
scripts/
README.md
install.md
cli.md
watch.md
config.md
output.md
validate.md
探索手順
タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:
- 下記マッピング表でタスクに対応するカテゴリを探す
- そのカテゴリの
references/{category}/README.mdを参照して目的のページを特定する - 該当ページの
.mdを Read して詳細を確認する
タスク → カテゴリ マッピング
| タスク | カテゴリ | 参照 README |
|---|---|---|
| インストール・CLI 使用法・Node.js からプログラマティックに使う・ブラウザバンドル | getting-started | references/getting-started/README.md |
| コメント構文・JSDoc/TSDoc 互換性・外部ドキュメント・宣言参照 | guides | references/guides/README.md |
| @param, @returns, @example, @category, @group 等のブロックタグ | tags-block | references/tags-block/README.md |
| @hidden, @internal, @override, @alpha, @beta 等のモディファイアタグ | tags-modifier | references/tags-modifier/README.md |
| @link, @inheritDoc, @include 等のインラインタグ | tags-inline | references/tags-inline/README.md |
| typedoc.json, entryPoints, out, theme 等の設定オプション | options | references/options/README.md |
| デフォルトテーマ・コミュニティテーマ・カスタム CSS | themes | references/themes/README.md |
| コミュニティプラグイン一覧 | plugins | references/plugins/README.md |
| カスタムテーマ開発・プラグイン開発・国際化・アーキテクチャ | development | references/development/README.md |
| Application, Converter, Renderer, Reflection 等のプログラマティック API | api | references/api/README.md |
| 典型的な使い方・設定例・ユースケースを知りたい | samples | samples/README.md |
| インストール・CLI コマンド・出力・バリデーション等の実行コマンドを知りたい | scripts | scripts/README.md |
FAQ
What does the typedoc skill do?
TypeDoc (TypeScript API ドキュメントジェネレーター) リファレンス。 typedoc.json、TSDoc タグ、CLI オプション、entryPoints、 テーマ (default / markdown)、プラグイン開発、 TSDoc / JSDoc コメントから HTML / Markdown ドキュメント生成。
How do I install typedoc?
Run npx skills add https://github.com/fandhe-ai/agent-reference-skills --skill typedoc in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/typedoc/ (personal) or .claude/skills/typedoc/ (project).
Which AI agents can use typedoc?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is typedoc safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains typedoc?
It is published by fandhe-ai in fandhe-ai/agent-reference-skills. It has 95 recorded installs.
More from fandhe-ai/agent-reference-skills
github-docs
fandhe-ai/agent-reference-skills
GitHub 公式ドキュメント (docs.github.com)。REST API, GraphQL, Webhooks, GitHub Apps, OAuth Apps, gh CLI, PAT / GITHUBTOKEN, Actions (jobs, steps, expressions, workflow commands, concurrency, OIDC, artifact attestations, lockfile), pull requests, issues, Projects v2, immutable releases, Codespaces, Packages, Copilot API / cloud agent, code scanning, secret scanning, Dependabot, Dependency graph / SBOM, Teams, Billing, activity (events / notifications)。
commitlint
fandhe-ai/agent-reference-skills
commitlint (Conventional Commits メッセージ検証ツール) リファレンス。 rules 設定、plugins、shareable-config、@commitlint/config-conventional、 Husky / lefthook / simple-git-hooks 連携、CI 統合、custom rules。
lefthook
fandhe-ai/agent-reference-skills
Lefthook (高速並列 Git hooks マネージャー) リファレンス。 lefthook.yml 設定、pre-commit / pre-push / commit-msg 等のフック、 parallel / piped 実行、glob / run / tags フィルタ、stagedfiles、 lefthook の ai 設定 (beta)、JSON schema、Composer / npm / pip 等インストール、 保護ブランチ、CI スキップ、Husky からの移行。
editorconfig
fandhe-ai/agent-reference-skills
EditorConfig (エディタ設定統一フォーマット) リファレンス。 .editorconfig ファイル、glob パターン、root、 indentstyle / indentsize / tabwidth、endofline, charset、 trimtrailingwhitespace, insertfinalnewline, maxlinelength, spellinglanguage。
rust
fandhe-ai/agent-reference-skills
Rust 言語リファレンス。 別名: rustlang, rs (拡張子)、Rust-lang。 TRPL (The Rust Programming Language)、Rust by Example、Reference、 Cargo Book、rustc Book、rustdoc Book、Rustonomicon (Unsafe Rust)、 Edition Guide、Standard Library、Error Index。 所有権、ライフタイム、トレイト、async / await、エラーハンドリング、マクロ。
anthropic-claude-code
fandhe-ai/agent-reference-skills
Claude Code (code.claude.com) の CLI 本体リファレンス。 CLAUDE.md memory, settings.json (All settings, settings precedence, managed-settings.json), env-vars, model config, keybindings, statusline, terminal config, cli-reference (-p / --continue / --resume), sessions, checkpointing, worktrees, remote control, channels, deep links, troubleshooting。
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.