react-essentials/typedoc.config.js at master · aweebit/react-essentials · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import packageJson from './package.json' with { type: 'json' };

/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */
const config = {
  entryPoints: ['./src/index.ts'],
  readme: './README-header.md',
  mergeReadme: true,
  out: '.',
  cleanOutputDir: false,
  gitRevision: `v${packageJson.version}`,
  plugin: ['typedoc-plugin-markdown'],
  router: 'module',
  hidePageHeader: true,
  hideGroupHeadings: true,
  groupOrder: ['Variables', 'Functions', '*'],
  useCodeBlocks: true,
  expandObjects: true,
  sort: ['source-order'],
  blockTagsPreserveOrder: ['@deprecated', '@example'],
  classPropertiesFormat: 'htmlTable',
  enumMembersFormat: 'htmlTable',
  interfacePropertiesFormat: 'htmlTable',
  parametersFormat: 'htmlTable',
  propertyMembersFormat: 'htmlTable',
  typeAliasPropertiesFormat: 'htmlTable',
  typeDeclarationFormat: 'htmlTable',
  tableColumnSettings: {
    hideSources: true,
  },
  formatWithPrettier: true,
  prettierConfigFile: './prettier.config.js',
  externalSymbolLinkMappings: {
    '@types/react': {
      'React.useLayoutEffect':
        'https://react.dev/reference/react/useLayoutEffect',
      'React.useReducer': 'https://react.dev/reference/react/useReducer',
      'React.useState': 'https://react.dev/reference/react/useState',
    },
  },
};

export default config;