Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@convex-dev/docusaurus-plugin-typedoc
Advanced tools
Readme
A Docusaurus v2 plugin to build documentation with TypeDoc.
Generates static TypeDoc pages in Markdown with frontmatter as part of the Docusaurus build.
Install Docusaurus in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
Add the plugin to docusaurus.config.js
and specify the required options (see options).
module.exports = {
plugins: [
[
'docusaurus-plugin-typedoc',
// Plugin / TypeDoc options
{
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
},
],
],
};
TypeDoc will be bootstraped with the Docusaurus start
and build
cli commands:
"start": "docusaurus start",
"build": "docusaurus build",
Once built the docs will be available at /docs/api
(or equivalent out directory).
├── 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
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
.
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.collapsed | true | Whether the parent category is initially collapsed |
sidebar.fullNames | false | Display full names with module path. |
sidebar.position | auto | The position of the sidebar in the tree. |
module.exports = {
plugins: [
[
'docusaurus-plugin-typedoc',
{
// TypeDoc options
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
plugin: ['typedoc-plugin-xyz'],
// Plugin options
out: 'api-xyz',
sidebar: {
categoryLabel: 'API XYZ',
collapsed: false,
position: 0,
fullNames: true,
},
},
],
],
};
sidebars.js
can be configured in following ways:
module.exports = {
sidebar: [
{
type: 'autogenerated',
dirName: '.', // '.' means the docs folder
},
],
};
note:
sidebar.categoryLabel
,sidebar.collapsed
, andsidebar.position
options are ignored with this implementation)
module.exports = {
sidebar: {
'Category 1': ['doc1', 'doc2', 'doc3'],
API: [
{
type: 'autogenerated',
dirName: 'api', // 'api' is the 'out' directory
},
],
},
};
Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
A navbar item can be configured in themeConfig
options in docusaurus.config.js
:
themeConfig: {
navbar: {
items: [
{
to: 'docs/api/', // 'api' is the 'out' directory
activeBasePath: 'docs',
label: 'API',
position: 'left',
},
],
},
},
Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
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
:
plugins: [
[
'docusaurus-plugin-typedoc',
{
// .... other plugin option
frontmatter: {
pagination_prev: null,
pagination_next: null
}
]
]
It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
docusaurus.config.js
module.exports = {
plugins: [
[
'docusaurus-plugin-typedoc',
{
id: 'api-1',
entryPoints: ['../api-1/src/index.ts'],
tsconfig: '../api-1/tsconfig.json',
out: 'api-1',
},
],
[
'docusaurus-plugin-typedoc',
{
id: 'api-2',
entryPoints: ['../api-2/src/index.ts'],
tsconfig: '../api-2/tsconfig.json',
out: 'api-2',
},
],
],
};
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
"start": "TYPEDOC_WATCH=true docusaurus start",
"build": "TYPEDOC_WATCH=false docusaurus build",
docusaurus.config.js
module.exports = {
plugins: [
[
'docusaurus-plugin-typedoc',
{
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
watch: process.env.TYPEDOC_WATCH,
},
],
],
};
docusaurus.config.js
module.exports = {
plugins: [
[
'docusaurus-plugin-typedoc',
{
entryPoints: ['../packages/package-a', '../packages/package-b'],
entryPointStrategy: 'packages',
sidebar: {
fullNames: true,
},
},
],
],
};
FAQs
A Docusaurus v2 plugin to build API documentation with TypeDoc.
The npm package @convex-dev/docusaurus-plugin-typedoc receives a total of 826 weekly downloads. As such, @convex-dev/docusaurus-plugin-typedoc popularity was classified as not popular.
We found that @convex-dev/docusaurus-plugin-typedoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.