typedoc

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 中确定目标页面：

1. 在下方映射表中查找与任务对应的类别
2. 参阅该类别的 references/{category}/README.md，确定目标页面
3. 使用 Read 读取相应的 .md 页面，查看详细信息

任务 → 类别映射

任务	类别	参考 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