milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.

docusaurus-plugin-typedoc-api

This project is no longer actively maintained! TypeScript and TypeDoc continually release breaking changes that make keeping this project in a workable state very difficult. It's not worth my time, so if you need this project, I suggest forking it.

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

Documentation

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

Contributing

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 [e-mail]:milesj/docusaurus-plugin-typedoc-api.git
cd docusaurus-plugin-typedoc-api
yarn install
yarn run pack

# Setup Boost
cd ..
git clone [e-mail]:milesj/boost.git
cd boost
yarn install
yarn 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.