https://github.com/typedoc2md/docusaurus-plugin-typedoc-example
An example of a Docusaurus project using the docusaurus-plugin-typedoc plugin.
https://github.com/typedoc2md/docusaurus-plugin-typedoc-example
Last synced: 28 days ago
JSON representation
An example of a Docusaurus project using the docusaurus-plugin-typedoc plugin.
- Host: GitHub
- URL: https://github.com/typedoc2md/docusaurus-plugin-typedoc-example
- Owner: typedoc2md
- Created: 2024-09-06T08:29:49.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-16T13:18:49.000Z (about 2 months ago)
- Last Synced: 2025-03-16T14:25:20.822Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://docusaurus-plugin-typedoc-example-docs-website.vercel.app
- Size: 548 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example: docusaurus-plugin-typedoc
This repository contains an example setup of using Typedoc with the [docusaurus-plugin-typedoc](https://typedoc-plugin-markdown.org/plugins/docusaurus).
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](https://docusaurus-plugin-typedoc-example-docs-website.vercel.app).
## Run Example Locally
To run the example locally:
### 1. Clone Repository
```shell
git clone https://github.com/typedoc2md/docusaurus-plugin-typedoc-example.git
cd docusaurus-plugin-typedoc-example
git submodule update --init --recursive
```
### 2. Install Dependencies
```shell
npm install
```
### 3. Build Examples
To run all examples:
```shell
npm run start
```