-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Steps
-
Install the npm packages
npm install --save-dev typedoc docusaurus-plugin-typedoc -
Configure typedoc plugin : In your docusaurus file (
docusaurus.config.js) add thedocusaurus-plugin-typedocplugin
module.exports = {
// other configurations...
plugins: [
[
'docusaurus-plugin-typedoc',
{
entryPoints: ['./src/index.ts'], // Specify the entry point(s) for your TypeScript code
out: './docs/api', // Output directory for the generated documentation
sidebar: {
categoryLabel: 'API Reference', // Label for the sidebar category
position: 2, // Position of the sidebar category (optional)
},
},
],
// other plugins...
],
};- Make sure the TS codebase is documented using JSDoc style comments
- Build your docusaurus site
npm run build
Metadata
Metadata
Assignees
Labels
No labels