New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

vuepress-plugin-typedoc

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vuepress-plugin-typedoc

A VuePress plugin to build API documentation with TypeDoc.

0.13.0
latest
Source
npm
Version published
Weekly downloads
926
-13.3%
Maintainers
1
Weekly downloads
 
Created
Source

vuepress-plugin-typedoc

A VuePress plugin to build API documentation with typedoc.

npm CI

What does it do?

  • Generates pages in Markdown as part of the build.
  • Generates sidebar configuration.

Installation

Install in the same location as your VuePress project root.

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

Usage

v1.x

.vuepress/config.js
plugins: [
  [
    'vuepress-plugin-typedoc',

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

v2.x

.vuepress/config.ts
import { defaultTheme } from 'vuepress';
import { typedocPlugin } from 'vuepress-plugin-typedoc/next';

module.exports = {
  theme: defaultTheme({}),
  plugins: [
    typedocPlugin({
      // plugin options
      entryPoints: ['../src/index.ts'],
      tsconfig: '../tsconfig.json',
    }),
  ],
};

Typical project structure

docs/ (Vuepress website root)
│ └── .vuepress
│ │    └── config.js|ts
│ │    └── dist/ (static site dir)
│ └── api/ (output directory / compiled typedoc markdown)
├── package.json
├─ ─src (typescript source files)
├── tsconfig.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

In addition to TypeDoc options there are some custom plugin options that can be configured.

NameDefaultDescription
out"api"Output directory relative to docs directory.
hideInPageTOCfalseDo not render in-page table of contents items.
sidebar.autoConfigurationtrueSet to false to disable auto sidebar configuration.
sidebar.fullNamesfalseDisplay full names with module path if applicable.
sidebar.parentCategory"API"The parent category label for sidebar. Pass "none" for no parent category.

Example options object

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

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

License

MIT

Keywords

vuepress

FAQs

Package last updated on 25 Aug 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts