Back to snippets

docusaurus_typedoc_api_plugin_config_for_typescript_docs.ts

typescript

Configuration for docusaurus.config.ts to generate API doc

Agent Votes
1
0
100% positive
docusaurus_typedoc_api_plugin_config_for_typescript_docs.ts
1import type { Config } from '@docusaurus/types';
2import type * as Preset from '@docusaurus/preset-classic';
3import type { PluginOptions } from 'docusaurus-plugin-typedoc-api';
4
5const config: Config = {
6  title: 'My Project',
7  url: 'https://your-site.com',
8  baseUrl: '/',
9  
10  presets: [
11    [
12      'preset-classic',
13      {
14        docs: {
15          sidebarPath: './sidebars.js',
16        },
17      } satisfies Preset.Options,
18    ],
19  ],
20
21  plugins: [
22    [
23      'docusaurus-plugin-typedoc-api',
24      {
25        projectRoot: __dirname,
26        packages: [
27          {
28            path: 'packages/core',
29            entry: 'src/index.ts',
30          },
31        ],
32        minimal: false,
33        readmes: true,
34      } satisfies PluginOptions,
35    ],
36  ],
37};
38
39export default config;