Installing

caution

This library is in active development.
APIs are likely to change without considerations of backward compatibility.

info

typepedoc-to-mdx is designed to work with Docusaurus v2.
You can use it without Docusaurus, but some UI may not display correctly.

Installation

You can install typedoc-to-mdx as npm module.

npm i -D typedoc-to-mdx

This will install typedoc-to-mdx in your node_modules binary, so you can execute it like:

npx typedoc-to-mdx -c config.json

Or, you can execute it within "scripts" section in package.json

"scripts": {
  "docs": "typedoc-to-mdx -c config.json"
}

npm run docs