Skip to content

[feature]: add docusaurus support #1

@instinxt

Description

@instinxt

Steps

  1. Install the npm packages
    npm install --save-dev typedoc docusaurus-plugin-typedoc

  2. Configure typedoc plugin : In your docusaurus file (docusaurus.config.js) add the docusaurus-plugin-typedoc plugin

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...
  ],
};
  1. Make sure the TS codebase is documented using JSDoc style comments
  2. Build your docusaurus site
    npm run build

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions