diff --git a/docs/README.md b/docs/README.md index 8a2ab63..7655f4b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/example/README.md b/example/README.md index eb4e17e..6dab7d5 100644 --- a/example/README.md +++ b/example/README.md @@ -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 diff --git a/packages/starlight-typedoc/README.md b/packages/starlight-typedoc/README.md index 402e93c..a5a29cb 100644 --- a/packages/starlight-typedoc/README.md +++ b/packages/starlight-typedoc/README.md @@ -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): - -Screenshot of a deprecated tag in Starlight - ## License Licensed under the MIT License, Copyright © HiDeoo.