typedoc

TypeDoc Reference

A skill covering all API documentation for TypeDoc (TypeScript documentation generator). Depending on the user's task, read the appropriate README.md and follow it to the individual files.

Directory structure

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

Exploration procedure

Derive the category from the task, and identify the target page in the category's README.md:

1. Find the category corresponding to the task in the mapping table below
2. of that category references/{category}/README.md Refer to this to identify the target page
3. For the relevant page, .md Read this to check the details

Task → Category Mapping

Task	Category	Reference README
Installation, CLI usage, using programmatically from Node.js, browser bundles	getting-started	references/getting-started/README.md
Comment syntax, JSDoc/TSDoc compatibility, external documentation, declaration references	guides	references/guides/README.md
Block tags such as @param, @returns, @example, @category, @group, etc.	tags-block	references/tags-block/README.md
Modifier tags such as @hidden, @internal, @override, @alpha, @beta, etc.	tags-modifier	references/tags-modifier/README.md
Inline tags such as @link, @inheritDoc, @include, etc.	tags-inline	references/tags-inline/README.md
Configuration options such as typedoc.json, entryPoints, out, theme, etc.	options	references/options/README.md
Default themes, community themes, custom CSS	themes	references/themes/README.md
List of community plugins	plugins	references/plugins/README.md
Custom theme development, plugin development, internationalization, architecture	development	references/development/README.md
Programmatic APIs such as Application, Converter, Renderer, Reflection, etc.	api	references/api/README.md
Want to know typical usage, configuration examples, use cases	samples	samples/README.md
Want to know execution commands such as installation, CLI commands, output, validation, etc.	scripts	scripts/README.md