https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad
An area to experiment with TypeDoc: local plugins, demoing bug fixes and POCs.
https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad
Last synced: 2 months ago
JSON representation
An area to experiment with TypeDoc: local plugins, demoing bug fixes and POCs.
- Host: GitHub
- URL: https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad
- Owner: typedoc2md
- Created: 2024-05-05T21:19:44.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T22:29:15.000Z (3 months ago)
- Last Synced: 2025-02-12T23:28:27.659Z (3 months ago)
- Language: TypeScript
- Size: 130 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# typedoc-plugin-markdown-scratchpad
An area to experiment with TypeDoc and typedoc-plugin-markdown - writing custom plugins, demoing bug fixes and POCs.
## Running Examples Locally
If you would like to explore the examples and configure yourself clone the repository locally:
### 1. Clone Repository
```shell
git clone [email protected]:typedoc2md/typedoc-plugin-markdown-scratchpad.git
cd typedoc-plugin-markdown-examples
```
### 2. Install Dependencies
```shell
npm install
```
### 3. Build Examples
To run all examples:
```shell
npm run docs
```
To run a specific example:
```shell
npm run docs --workspace issue-123
```