vuepress-plugin-typedoc

vuepress-plugin-typedoc

A VuePress plugin to build API 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

This guide assumes that VuePress has already been locally installed. See getting started docs.

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

Usage

Add the plugin to .vuepress/config.js:

module.exports = {
  plugins: [
    [
      'vuepress-plugin-typedoc',

      // plugin options
      {
        // list of input files relative to docusaurus.config.js
        inputFiles: ['../../src/'],

        // out directory relative to docs folder (defaults to `api`)
        out: 'api',

        // options for auto generated sidebars.json (pass `null` to skip generation completely)
        sidebar: {
          // display full names with module path if applicable - (defaults to 'false')
          fullNames: false,
          // the parent category label for sidebar - (defaults to `none` - no parent category)
          parentCategory: 'none',
        },

        // include additional TypeDoc plugins in addition to the markdown plugin (optional)
        plugin: ['typedoc-plugin-xyz'],

        // Pass in any additional TypeDoc options (see typedoc --help)
        mode: 'modules',
      },
    ],
  ],
};

Notes

• Once built the docs will be available at /api or equivalent out directory.
• By default TypeDoc will attempt to clean-up the output directory and will error if the directory contains un-recognised documents. To skip this step and copy files on-top of the output directory use the disableOutputCheck: true option.