vuepress-plugin-typedoc

A VuePress plugin to build documentation with TypeDoc.

What it does?

• Generates pages as part of the build.
• Adds Front Matter to pages.
• Generates sidebars config to enable navigation.

Installation

Install in the same location as the VuePress root directory.

This guide assumes that a VuePress project has been setup. See getting started docs.

npm install typedoc typedoc-plugin-markdown vuepress-plugin-typedoc --save-dev

Usage

Config

Add the plugin to .vuepress/config.js and specify the required options (see options).

plugins: [
  [
    'vuepress-plugin-typedoc',

    // Plugin / TypeDoc options
    {
      entryPoints: ['../src/index.ts'],
      tsconfig: '../tsconfig.json'
    },
  ],
],

TypeDoc will be bootstraped with the Vuepress dev and build cli commands:

"dev": "vuepress dev [targetDir]",
"build": "vuepress build [targetDir]",

Once built the docs will be available at /api or equivalent out directory.

docs/ (Vuepress website root)
├── src/
│   └── .vuepress
│   │    └───config.js
│   │    └───dist/ (static site dir)
│   └── api/ (compiled typedoc markdown)
├── package.json

Options

TypeDoc options

To configure TypeDoc, pass any relevant TypeDoc options to the config.

At a minimum the entryPoints and tsconfig options will need to be set.

entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json'

Additional TypeDoc plugins will need to be explicitly set:

plugin:['typedoc-plugin-xyz']

TypeDoc options can also be declared:

• Using a typedoc.json file.
• Under the typedocOptions key in tsconfig.json.

Note: Options declared in this manner will take priority and overwrite options declared in docusaurus.config.js.

Plugin options

Example config

  plugins: [
    [
      'vuepress-plugin-typedoc',
      {
        // TypeDoc options
        entryPoints: ['../src/index.ts'],
        tsconfig: '../tsconfig.json',

        // Plugin options
        out: 'api',
        sidebar: {
          fullNames: true,
          parentCategory: 'API',
        },
      },
    ],
  ],

License

MIT