docusaurus-plugin-typedoc-api

This is a fork of milesj/docusaurus-plugin-typedoc-api to support the latest typescript, typedoc, and docusaurus versions for the docs-website of CARTA frontend.

A Docusaurus plugin for generating source code /api/* routes, powered by TypeDoc.

View the official readme for more information on installation and usage.

Since this repository doesn't have a public API, nor is its source code organized in a way to utilize TypeDoc, we rely on the types provided by Boost. To contribute, you'll need to clone the Boost project relative to this project as a sibling.

# Setup plugin
git clone git@github.com:milesj/docusaurus-plugin-typedoc-api.git
cd docusaurus-plugin-typedoc-api
npm install
npm run pack

# Setup Boost
cd ..
git clone git@github.com:milesj/boost.git
cd boost
npm install
npm run pack

After both projects are setup, you can make modifications to this project and then verify the changes by starting the Docusaurus server with yarn run docs. However, hot reloading does not work, so you'll unfortunately need to run this command over and over again... haven't spent the time improving this yet.