srizan/archived-starlight-typedoc
1
0
Fork 0
mirror of https://github.com/SrIzan10/starlight-typedoc.git synced 2026-05-01 11:05:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme files

Browse Source
This commit is contained in:
HiDeoo
2024-06-25 09:09:01 +02:00
parent 932d628c43
commit 2299721750
3 changed files with 3 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -15,7 +15,7 @@
## Docs
Run the docs locally using your favorite package manager, e.g. with [pnpm](https://pnpm.io):
Run the docs locally using [pnpm](https://pnpm.io):
```shell
pnpm run dev

2
example/README.md
View File

@@ -15,7 +15,7 @@
## Example
Run the example locally using your favorite package manager, e.g. with [pnpm](https://pnpm.io):
Run the example locally using [pnpm](https://pnpm.io):
```shell
pnpm run dev

8
packages/starlight-typedoc/README.md
View File

@@ -20,18 +20,12 @@
## Getting Started
Want to get started immediately? Check out the [getting started guide](https://starlight-typedoc.vercel.app/getting-started/).
Want to get started immediately? Check out the [getting started guide](https://starlight-typedoc.vercel.app/getting-started/) or check out the [demo](https://starlight-typedoc-example.vercel.app) to see the plugin in action.
## Features
A [Starlight](https://starlight.astro.build) plugin using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) to generate documentation from TypeScript code.
Check out the [example](https://starlight-typedoc-example.vercel.app) for a preview of the generated documentation.
Some [TSDoc](https://tsdoc.org) tags uses a custom Markdown syntax, e.g. the `@deprecated`, `@alpha`, `@beta` and `@experimental` tags using Starlight [asides](https://starlight.astro.build/guides/authoring-content/#asides):
<img alt="Screenshot of a deprecated tag in Starlight" src="https://i.imgur.com/18ZA5vN.png" width="672" />
## License
Licensed under the MIT License, Copyright © HiDeoo.