https://github.com/neplextech/typedoc-nextra

Build a documentation website with TypeDoc and Nextra
https://github.com/neplextech/typedoc-nextra

api documentation markdown nextra node typedoc typescript

Last synced: 20 days ago
JSON representation

Build a documentation website with TypeDoc and Nextra

• Host: GitHub
• URL: https://github.com/neplextech/typedoc-nextra
• Owner: neplextech
• License: mit
• Archived: true
• Created: 2023-01-23T06:53:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T08:32:01.000Z (about 1 year ago)
• Last Synced: 2024-10-01T22:05:13.984Z (4 months ago)
• Topics: api, documentation, markdown, nextra, node, typedoc, typescript
• Language: TypeScript
• Homepage: https://typedoc-nextra.netlify.app
• Size: 911 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
**This project has been replaced by [micro-docgen](https://github.com/neplextech/micro-docgen)**

---

# typedoc-nextra

Generate markdown/simple json from typedoc

# Installation

```sh

yarn add typedoc-nextra typedoc

```

# Output Directory Structure

-   output/

    -   classes/

        -   module/

            -   class.mdx

    -   types/

        -   module/

            -   type.mdx

    -   custom/

        -   file.mdx

# Example

```js

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

});

```