0.1.5

Changelog

• Fix module resolution

Full Changelog: v0.1.3...v0.1.5

0.1.4

Changelog

• Function output generator
• Updated linker

0.1.3

Changelog

• Add default links
• Enable types linker by default
• Fix generator
• Fix comments being cut off
• Fix example codeblock issue
• Remove description field when no description is available

Full Changelog: v0.1.2...v0.1.3

0.1.2

Changes

• fix: project checking

Full Changelog: v0.1.1...v0.1.2

0.1.1

Changes

• fix: custom file ext

Full Changelog: v0.1.0...v0.1.1

0.1.0

typedoc-nextra

Use TypeDoc with Nextra

Installation

yarn add typedoc-nextra

This tool was built for generating docs automatically to be used in nextra. However, it can be used elsewhere.

Output Directory Structure

• output/
  • classes/
    • module/
      • class.mdx
  • types/
    • module/
      • type.mdx
  • custom/
    • file.mdx

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
});

Full Changelog: https://github.com/neplextech/typedoc-nextra/commits/v0.1.0