Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
vuepress-plugin-typedoc
Advanced tools
A VuePress plugin to build API documentation with typedoc.
Install in the same location as your VuePress project root.
npm install typedoc typedoc-plugin-markdown vuepress-plugin-typedoc --save-dev
.vuepress/config.js
and specify the required options (see options).dev
and build
cli commands..vuepress/config.js
plugins: [
[
'vuepress-plugin-typedoc',
// plugin options
{
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json'
},
],
],
.vuepress/config.ts
under the next
entrypoint and specify the required options (see options).dev
and build
cli commands..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',
}),
],
};
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
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:
typedoc.json
file.typedocOptions
key in tsconfig.json
.Note: Options declared in this manner will take priority and overwrite options declared in docusaurus.config.js
.
In addition to TypeDoc options there are some custom plugin options that can be configured.
Name | Default | Description |
---|---|---|
out | "api" | Output directory relative to docs directory. |
hideInPageTOC | false | Do not render in-page table of contents items. |
sidebar.autoConfiguration | true | Set to false to disable auto sidebar configuration. |
sidebar.fullNames | false | Display full names with module path if applicable. |
sidebar.parentCategory | "API" | The parent category label for sidebar. Pass "none" for no parent category. |
{
// TypeDoc options
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
cleanOutputDir: true
// Plugin options
out: 'api',
sidebar: {
fullNames: true,
parentCategory: 'API',
}
}
FAQs
A VuePress plugin to build API documentation with TypeDoc.
The npm package vuepress-plugin-typedoc receives a total of 509 weekly downloads. As such, vuepress-plugin-typedoc popularity was classified as not popular.
We found that vuepress-plugin-typedoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.