npmpackage.info

vuepress-plugin-typedoc

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

0.13.0

746

MIT

TypeScript

1.92 kB

134,774 3.8

Installations

npm install vuepress-plugin-typedoc

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Node Version

16.20.0

NPM Version

8.19.4 Score

63.9

Supply Chain

97.9

Quality

75.9

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

0

Total

273

Closed

56

Merged

217

Issues

Open

6

Total

472

Closed

466

Releases

136

typedoc-plugin-markdown@4.4.1

Published on 01 Jan 2025

typedoc-plugin-markdown@4.4.0

Published on 30 Dec 2024

typedoc-plugin-markdown@4.3.3

Published on 18 Dec 2024

typedoc-plugin-markdown@4.3.2

Published on 08 Dec 2024

typedoc-plugin-markdown@4.3.1

Published on 01 Dec 2024

typedoc-plugin-markdown@4.3.0

Published on 27 Nov 2024

View all 136 releases

Contributors

Unable to fetch Contributors

View all 36 contributors

Languages

TypeScript

JavaScript

CSS

TypeScript (92.35%)

JavaScript (7.64%)

CSS (0.02%)

Developer

tgreyuk

Download Statistics

Total Downloads

134,774

Last Day

186

Last Week

759

Last Month

3,127

Last Year

59,078

GitHub Statistics

746 Stars

2,303 Commits

182 Forks

9 Watching

7 Branches

36 Contributors

Bundle Size

5.07 kB

Minified

1.92 kB

Minified + Gzipped

Bundlephobia

Maintainers

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

NPM Version

8.19.4

Node Version

16.20.0

Publised On

25 Aug 2023

Total Downloads

Cumulative downloads

Total Downloads

134,774

Last day

-7.5%

186

Compared to previous day

Last week

-13.7%

759

Compared to previous week

Last month

-17%

3,127

Compared to previous month

Last year

181%

59,078

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

typedoc typedoc-plugin-markdown

Dev Dependencies

typedoc-plugin-markdown

Versions

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.js and specify the required options (see options).
TypeDoc will be bootstraped with the Vuepress dev and build cli 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.ts under the next entrypoint and specify the required options (see options).
TypeDoc will be bootstraped with the Vuepress dev and build cli 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.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.

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

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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:24: 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:26: 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-github-wiki-theme.yml:24: 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:26: 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:24: 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:26: 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:24: 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:26: 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:24: 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:26: 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:24: 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:26: 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:30: 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:32: 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:13: 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:15: 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:22: update your workflow using https://app.stepsecurity.io/secureworkflow/typedoc2md/typedoc-plugin-markdown/release.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.docusaurus-plugin-typedoc.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/ci.typedoc-github-wiki-theme.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/ci.typedoc-gitlab-wiki-theme.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/ci.typedoc-plugin-frontmatter.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/ci.typedoc-plugin-remark.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/ci.typedoc-vitepress-theme.yml:32
Warn: npmCommand not pinned by hash: .github/workflows/release.yml:20
Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 1 out of 8 npmCommand dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

55 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
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-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986 / GHSA-64vr-g452-qvp3
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
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-9cwx-2883-4wfx
Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
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-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-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-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
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-353f-5xf4-qw67
Warn: Project is vulnerable to: GHSA-f9xv-q969-pqx4
Warn: Project is vulnerable to: GHSA-cg87-wmx4-v546

Score

3.8

/10

Last Scanned on 2025-01-27

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

Other packages similar to vuepress-plugin-typedoc

typedoc-vitepress-theme

1.1.2

A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.

@jiereal/vuepress-plugin-typedoc

0.11.1

A VuePress plugin to build API documentation with TypeDoc.

@sileigiser/vuepress-plugin-typedoc

0.0.2

A VuePress plugin to build API documentation with TypeDoc.

@terwer/typedoc-vitepress-theme

1.0.0-next.0-terwer.1

A typedoc-plugin-markdown theme that publishes Markdown pages compatible with VitePress.