typedoc-nextra
Generate markdown/simple json from typedoc
Installation
yarn add typedoc-nextra typedoc
Output Directory Structure
- output/
- classes/
- module/
- class.mdx
- module/
- types/
- module/
- type.mdx
- module/
- custom/
- file.mdx
- classes/
Example
import { createDocumentation } from 'typedoc-nextra';
await createDocumentation({
// use existing typedoc json output (leave it blank to auto generate)
jsonInputPath: `${__dirname}/data.json`,
// output location
output: `${__dirname}/pages`,
// output markdown
markdown: true
});