Gathering detailed insights and metrics for vuepress-plugin-typedoc
Gathering detailed insights and metrics for vuepress-plugin-typedoc
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
Installations
npm install vuepress-plugin-typedocDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Node Version
16.20.0
NPM Version
8.19.4
Releases
146
typedoc-plugin-markdown@4.7.0
typedoc-plugin-markdown@4.7.0
Updated on Jun 20, 2025
typedoc-plugin-markdown@4.6.4
typedoc-plugin-markdown@4.6.4
Updated on Jun 01, 2025
typedoc-plugin-markdown@4.6.3
typedoc-plugin-markdown@4.6.3
Updated on Apr 23, 2025
typedoc-plugin-markdown@4.6.2
typedoc-plugin-markdown@4.6.2
Updated on Apr 09, 2025
typedoc-plugin-markdown@4.6.1
typedoc-plugin-markdown@4.6.1
Updated on Apr 02, 2025
typedoc-plugin-markdown@4.6.0
typedoc-plugin-markdown@4.6.0
Updated on Mar 23, 2025
Languages
4
TypeScript
JavaScript
CSS
MDX
TypeScript (93.76%)
JavaScript (5.76%)
CSS (0.36%)
MDX (0.11%)
Developer
Download Statistics
Total Downloads
161,488
Last Day
210
Last Week
2,060
Last Month
9,834
Last Year
71,304
GitHub Statistics
MIT License
778 Stars
2,448 Commits
181 Forks
9 Watchers
4 Branches
39 Contributors
Updated on Jun 26, 2025
Bundle Size
5.07 kB
Minified
1.92 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.13.0
Package Id
vuepress-plugin-typedoc@0.13.0
Unpacked Size
22.96 kB
Size
6.20 kB
File Count
21
NPM Version
8.19.4
Node Version
16.20.0
Published on
Aug 25, 2023
Total Downloads
Cumulative downloads
Total Downloads
161,488
Last Day
8.8%
210
Compared to previous day
Last Week
-27.4%
2,060
Compared to previous week
Last Month
16.9%
9,834
Compared to previous month
Last Year
138.1%
71,304
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
1
vuepress-plugin-typedoc
A VuePress plugin to build API documentation with typedoc.
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.
1npm install typedoc typedoc-plugin-markdown vuepress-plugin-typedoc --save-dev
Usage
v1.x
- Setup a VuePress project https://v1.vuepress.vuejs.org/guide/getting-started.html.
- Add the plugin to
.vuepress/config.jsand specify the required options (see options). - TypeDoc will be bootstraped with the Vuepress
devandbuildcli commands.
.vuepress/config.js
1plugins: [ 2 [ 3 'vuepress-plugin-typedoc', 4 5 // plugin options 6 { 7 entryPoints: ['../src/index.ts'], 8 tsconfig: '../tsconfig.json' 9 }, 10 ], 11],
v2.x
- Setup a VuePress v2 project https://v2.vuepress.vuejs.org/guide/getting-started.html.
- Using a plugin via string is not supported. Import the plugin directly in
.vuepress/config.tsunder thenextentrypoint and specify the required options (see options). - TypeDoc will be bootstraped with the Vuepress
devandbuildcli commands.
.vuepress/config.ts
1import { defaultTheme } from 'vuepress'; 2import { typedocPlugin } from 'vuepress-plugin-typedoc/next'; 3 4module.exports = { 5 theme: defaultTheme({}), 6 plugins: [ 7 typedocPlugin({ 8 // plugin options 9 entryPoints: ['../src/index.ts'], 10 tsconfig: '../tsconfig.json', 11 }), 12 ], 13};
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.
1entryPoints: ['../src/index.ts'], 2tsconfig: '../tsconfig.json'
Additional TypeDoc plugins will need to be explicitly set:
1plugin: ['typedoc-plugin-xyz'];
TypeDoc options can also be declared:
- Using a
typedoc.jsonfile. - Under the
typedocOptionskey intsconfig.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.
| 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. |
Example options object
1{ 2 // TypeDoc options 3 entryPoints: ['../src/index.ts'], 4 tsconfig: '../tsconfig.json', 5 cleanOutputDir: true 6 7 // Plugin options 8 out: 'api', 9 sidebar: { 10 fullNames: true, 11 parentCategory: 'API', 12 } 13}
License
No vulnerabilities found.
Reason
30 commit(s) and 16 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 5/19 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.docusaurus-plugin-typedoc.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-docusaurus-theme.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-github-wiki-theme.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-gitlab-wiki-theme.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-plugin-frontmatter.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-plugin-remark.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.typedoc-vitepress-theme.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.docusaurus-plugin-typedoc.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.docusaurus-plugin-typedoc.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.docusaurus-plugin-typedoc.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.docusaurus-plugin-typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.docusaurus-plugin-typedoc.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.docusaurus-plugin-typedoc.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-docusaurus-theme.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-docusaurus-theme.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-docusaurus-theme.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-docusaurus-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-docusaurus-theme.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-docusaurus-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-github-wiki-theme.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-github-wiki-theme.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-github-wiki-theme.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-github-wiki-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-github-wiki-theme.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-github-wiki-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-gitlab-wiki-theme.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-gitlab-wiki-theme.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-gitlab-wiki-theme.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-gitlab-wiki-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-gitlab-wiki-theme.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-gitlab-wiki-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-frontmatter.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-frontmatter.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-frontmatter.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-frontmatter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-frontmatter.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-frontmatter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-remark.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-remark.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-remark.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-remark.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-plugin-remark.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-plugin-remark.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-vitepress-theme.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-vitepress-theme.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.typedoc-vitepress-theme.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-vitepress-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.typedoc-vitepress-theme.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.typedoc-vitepress-theme.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/release.yml/main?enable=pin
- Info: 0 out of 18 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 10 third-party GitHubAction dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 16 are checked with a SAST tool
Reason
73 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-f7f6-9jq7-3rqj
- Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh
- Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42
- Warn: Project is vulnerable to: GHSA-m5qc-5hw7-8vg7
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
- Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c24v-8rfc-w8vw
- Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67
- Warn: Project is vulnerable to: GHSA-f9xv-q969-pqx4
Score
4
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More