README.md

Example: docusaurus-plugin-typedoc

This repository contains an example setup of using Typedoc with the docusaurus-plugin-typedoc.

Please note this is just an example directory structure. You would most likely want to organise your docusaurus project into a separate website directory on a real project.

View Example

You can view the published build on the demo website.

Run Example Locally

To run the example locally:

1. Clone Repository

git clone https://github.com/typedoc2md/docusaurus-plugin-typedoc-example.git
cd docusaurus-plugin-typedoc-example
git submodule update --init --recursive

2. Install Dependencies

npm install

3. Build Examples

To run all examples:

npm run start