Package Exports

vuepress-plugin-typedoc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vuepress-plugin-typedoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vuepress-plugin-typedoc

A VuePress plugin to build API documentation with TypeDoc and the Markdown plugin.

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 a VuePress project has been setup. See getting started docs.

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

Install in the same location as the VuePress root directory.

Usage

Add the plugin to .vuepress/config.js:

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

    // Plugin / TypeDoc options (see typedoc --help)
    {
      entryPoints: ['../src/index.ts'],
      tsconfig: '../tsconfig.json'
    },
  ],
],

Options

TypeDoc options

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

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

Please refer to TypeDoc for further options.

Plugin options

out<string>

Output directory relative to docs directory. Defaults to "api".

allReflectionsHaveOwnDocument<boolean>

Output all reflections into seperate output files. Defaults to false.

hideInPageTOC<boolean>

Do not render in-page table of contents items. Defaults to false.

sidebar<object>

Options object for auto generated sidebar. (pass null to skip generation completely)
- fullNames<object>
Display full names with module path if applicable. Default to false.
- parentCategory<string>
The parent category label for sidebar - (defaults to none - no parent category)

Full example

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

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

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