Gathering detailed insights and metrics for @jiereal/docusaurus-plugin-typedoc
Gathering detailed insights and metrics for @jiereal/docusaurus-plugin-typedoc
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
Installations
npm install @jiereal/docusaurus-plugin-typedocDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
16.17.1
NPM Version
8.15.0
Score
62.2
Supply Chain
99
Quality
75.2
Maintenance
100
Vulnerability
99.3
License
Releases
136
typedoc-plugin-markdown@4.4.1
typedoc-plugin-markdown@4.4.1
Published on 01 Jan 2025
typedoc-plugin-markdown@4.4.0
typedoc-plugin-markdown@4.4.0
Published on 30 Dec 2024
typedoc-plugin-markdown@4.3.3
typedoc-plugin-markdown@4.3.3
Published on 18 Dec 2024
typedoc-plugin-markdown@4.3.2
typedoc-plugin-markdown@4.3.2
Published on 08 Dec 2024
typedoc-plugin-markdown@4.3.1
typedoc-plugin-markdown@4.3.1
Published on 01 Dec 2024
typedoc-plugin-markdown@4.3.0
typedoc-plugin-markdown@4.3.0
Published on 27 Nov 2024
Contributors
36
Unable to fetch Contributors
Languages
3
TypeScript
JavaScript
CSS
TypeScript (92.55%)
JavaScript (7.43%)
CSS (0.02%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
745 Stars
2,300 Commits
182 Forks
9 Watching
6 Branches
36 Contributors
Maintainers
1
Package Meta Information
Latest Version
0.17.6
Package Id
@jiereal/docusaurus-plugin-typedoc@0.17.6
Unpacked Size
28.50 kB
Size
7.74 kB
File Count
15
NPM Version
8.15.0
Node Version
16.17.1
Total Downloads
Cumulative downloads
Total Downloads
0
Last day
0%
0
Compared to previous day
Last week
0%
0
Compared to previous week
Last month
0%
0
Compared to previous month
Last year
0%
0
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
1
Versions
docusaurus-plugin-typedoc
A Docusaurus v2 plugin to build documentation with TypeDoc.
What it does?
Generates static TypeDoc pages in Markdown with frontmatter as part of the Docusaurus build.
Installation
Install Docusaurus in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
1npm install typedoc @jiereal/typedoc-plugin-markdown @jiereal/docusaurus-plugin-typedoc --save-dev
Usage
Config
Add the plugin to docusaurus.config.js and specify the required options (see options).
1module.exports = { 2 plugins: [ 3 [ 4 '@jiereal/docusaurus-plugin-typedoc', 5 6 // Plugin / TypeDoc options 7 { 8 entryPoints: ['../src/index.ts'], 9 tsconfig: '../tsconfig.json', 10 }, 11 ], 12 ], 13};
TypeDoc will be bootstraped with the Docusaurus start and build cli commands:
1"start": "docusaurus start", 2"build": "docusaurus build",
Once built the docs will be available at /docs/api (or equivalent out directory).
Directory structure
├── docusauruss-website
├── build/ (static site dir)
├── docs/
│ ├── api/ (compiled typedoc markdown)
├── docusaurus.config.js
├── package.json
├── sidebars.js
├──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'];
Other config options
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
Options specific to the plugin should also be declared in the same object.
| Name | Default | Description |
|---|---|---|
out | "api" | Output dir relative to docs dir (use . for no subdir). |
includeExtension | true | Determines whether to preserve the .md extension in relative links. true is recommended as per Docusaurus documentation |
frontmatter | null | Additional frontmatter options object. See Frontmatter. |
sidebar.categoryLabel | API | The sidebar parent category label. |
sidebar.fullNames | false | Display full names with module path. |
sidebar.position | auto | The position of the sidebar in the tree. |
An example configuration
1module.exports = { 2 plugins: [ 3 [ 4 '@jiereal/docusaurus-plugin-typedoc', 5 { 6 // TypeDoc options 7 entryPoints: ['../src/index.ts'], 8 tsconfig: '../tsconfig.json', 9 plugin: ['typedoc-plugin-xyz'], 10 11 // Plugin options 12 out: 'api-xyz', 13 sidebar: { 14 categoryLabel: 'API XYZ', 15 position: 0, 16 fullNames: true, 17 }, 18 }, 19 ], 20 ], 21};
Recipes
Sidebar and Navbar
Sidebar
sidebars.js can be configured in following ways:
- Generate the entire sidebar from file structure of your docs folder (default behaviour):
1module.exports = { 2 sidebar: [ 3 { 4 type: 'autogenerated', 5 dirName: '.', // '.' means the docs folder 6 }, 7 ], 8};
- Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
note:
sidebar.categoryLabelandsidebar.positionoptions are ignored with this implementation)
1module.exports = { 2 sidebar: { 3 'Category 1': ['doc1', 'doc2', 'doc3'], 4 API: [ 5 { 6 type: 'autogenerated', 7 dirName: 'api', // 'api' is the 'out' directory 8 }, 9 ], 10 }, 11};
Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
Navbar
A navbar item can be configured in themeConfig options in docusaurus.config.js:
1 themeConfig: { 2 navbar: { 3 items: [ 4 { 5 to: 'docs/api/', // 'api' is the 'out' directory 6 activeBasePath: 'docs', 7 label: 'API', 8 position: 'left', 9 }, 10 ], 11 }, 12},
Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
Frontmatter
By default the plugin will configure minimal required Frontmatter configuration.
Additionally required global Frontmatter options can be passed in using the frontmatter options object
docusaurus.config.js:
1plugins: [ 2 [ 3 '@jiereal/docusaurus-plugin-typedoc', 4 { 5 // .... other plugin option 6 frontmatter: { 7 pagination_prev: null, 8 pagination_next: null 9 } 10 ] 11]
Multi instance
It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
docusaurus.config.js
1module.exports = { 2 plugins: [ 3 [ 4 '@jiereal/docusaurus-plugin-typedoc', 5 { 6 id: 'api-1', 7 entryPoints: ['../api-1/src/index.ts'], 8 tsconfig: '../api-1/tsconfig.json', 9 out: 'api-1', 10 }, 11 ], 12 [ 13 '@jiereal/docusaurus-plugin-typedoc', 14 { 15 id: 'api-2', 16 entryPoints: ['../api-2/src/index.ts'], 17 tsconfig: '../api-2/tsconfig.json', 18 out: 'api-2', 19 }, 20 ], 21 ], 22};
Watch mode
Watching files is supported by passing in the watch: true option see https://typedoc.org/guides/options/#watch.
Targetting the option in development mode only can be achieved using Node.js Environment Variables:
package.json
1"start": "TYPEDOC_WATCH=true docusaurus start", 2"build": "TYPEDOC_WATCH=false docusaurus build",
docusaurus.config.js
1module.exports = { 2 plugins: [ 3 [ 4 '@jiereal/docusaurus-plugin-typedoc', 5 { 6 entryPoints: ['../src/index.ts'], 7 tsconfig: '../tsconfig.json', 8 watch: process.env.TYPEDOC_WATCH, 9 }, 10 ], 11 ], 12};
Monorepo setup
docusaurus.config.js
1module.exports = { 2 plugins: [ 3 [ 4 '@jiereal/docusaurus-plugin-typedoc', 5 { 6 entryPoints: ['../packages/package-a', '../packages/package-b'], 7 entryPointStrategy: 'packages', 8 sidebar: { 9 fullNames: true, 10 }, 11 }, 12 ], 13 ], 14};
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 27 issue activity found in the last 90 days -- score normalized to 10
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 1/17 approved changesets -- score normalized to 0
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-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
no effort to earn an OpenSSF best practices badge detected
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
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
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
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