TypeDoc Plugin for Vue and Pinia

1.5.1 · active · verified Sun Apr 19

typedoc-plugin-vue is a TypeDoc plugin designed to enhance the generated documentation for projects utilizing Vue 3's `defineComponent` and Pinia's `defineStore` constructs. It specifically improves how these framework-specific patterns are parsed and displayed, making the documentation more accurate and readable. Additionally, it attempts to recognize `FunctionalComponent` variables and convert them into a class-like representation within the documentation output. The current stable version is 1.5.1, released in October 2025. The plugin maintains an active release cadence, frequently updating to support new major versions of TypeDoc, with recent updates for TypeDoc 0.28. Its key differentiator is providing specialized parsing for Vue and Pinia, which vanilla TypeDoc does not natively optimize, ensuring that component properties, store actions, and getters are presented clearly.

Common errors

```
Error: The plugin 'typedoc-plugin-vue' could not be found.
```
cause The package was not installed, or TypeDoc cannot locate it (e.g., due to incorrect `plugin` path in configuration or `node_modules` resolution issues).

fix Ensure `typedoc-plugin-vue` is installed as a `devDependency` (`npm install --save-dev typedoc-plugin-vue`) and that the `plugin` array in `typedoc.json` correctly lists its name: `"plugin": ["typedoc-plugin-vue"]`.
```
Plugin typedoc-plugin-vue is not compatible with TypeDoc X.Y.Z
```
cause The installed version of `typedoc-plugin-vue` has a peer dependency requirement for TypeDoc that does not match your installed TypeDoc version.

fix Upgrade `typedoc-plugin-vue` to its latest version (`npm update typedoc-plugin-vue`) or a specific version known to support your TypeDoc version. Alternatively, adjust your TypeDoc version to match the plugin's peer dependency range (e.g., `npm install typedoc@0.28.x`).

Warnings

breaking Older versions of typedoc-plugin-vue may not be compatible with newer major versions of TypeDoc. Always ensure your plugin version supports your TypeDoc version to avoid parsing errors or incomplete documentation.
Fix: Upgrade typedoc-plugin-vue to the latest version. Check the plugin's changelog for explicit TypeDoc version support before upgrading TypeDoc itself. For TypeDoc 0.28.x, use typedoc-plugin-vue >=1.5.0.
gotcha The `excludeVueProperties` option was introduced in v1.4.0 and defaults to `true`. If you require properties like `$props`, `$watch`, or `$emit` to be documented for some reason, you must explicitly set this option to `false`.
Fix: Set `"excludeVueProperties": false` in your `typedoc.json` configuration if you need these internal Vue properties included in your documentation.
gotcha The plugin needs to be specified correctly in the `plugin` array within `typedoc.json`. Typos or incorrect configuration paths will prevent the plugin from loading.
Fix: Verify that `"plugin": ["typedoc-plugin-vue"]` is correctly spelled and located in your `typedoc.json` file. Ensure `npm install` was run and the package is available in `node_modules`.

Install

npm install typedoc-plugin-vue npm
yarn add typedoc-plugin-vue yarn
pnpm add typedoc-plugin-vue pnpm

Imports

plugin entry
wrong:
```
import 'typedoc-plugin-vue';
```
correct:
```
{
    "plugin": ["typedoc-plugin-vue"]
}
```
This package is a TypeDoc plugin configured via `typedoc.json` or command-line options, not directly imported into JavaScript/TypeScript source files.
excludeVueProperties option
```
{
    "plugin": ["typedoc-plugin-vue"],
    "excludeVueProperties": true
}
```
A plugin-specific option configured within `typedoc.json` to control the exclusion of default Vue properties like `$props`.

Quickstart

Demonstrates installation and basic configuration in `typedoc.json` to enable the plugin and exclude common Vue properties, ready for documentation generation.

npm install --save-dev typedoc typedoc-plugin-vue

// typedoc.json
{
    "entryPoints": ["./src/index.ts"],
    "out": "docs",
    "plugin": ["typedoc-plugin-vue"],
    "excludeVueProperties": true,
    "includeEntryPoint": false,
    "tsconfig": "./tsconfig.json"
}

view raw JSON →