Skip to content
This repository was archived by the owner on Dec 7, 2023. It is now read-only.

neplextech/typedoc-nextra

This project has been replaced by micro-docgen


typedoc-nextra

Generate markdown/simple json from typedoc

Installation

yarn add typedoc-nextra typedoc

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

About

Build a documentation website with TypeDoc and Nextra

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published