Releases: HiDeoo/starlight-typedoc
Releases · HiDeoo/starlight-typedoc
v0.12.1
v0.12.0
🚨 Breaking Changes
View changes on GitHub
v0.11.1
🐞 Bug Fixes
View changes on GitHub
v0.11.0
v0.10.1
🐞 Bug Fixes
- Fixes broken links in block tag comments using
@link
tags with thepackages
entry point strategy - by @HiDeoo (a7982)
View changes on GitHub
v0.10.0
v0.9.0
v0.8.0
v0.7.0
🚨 Breaking Changes
-
Bump minimum required Astro version to 4.0 and Starlight to 0.15.0 - by @HiDeoo (8ee3f)
-
Starlight TypeDoc is now a Starlight plugin - by @HiDeoo (7973b)
You will need to update your Astro configuration to remove the previous version and add the new version as a Starlight plugin in your
astro.config.mjs
file:import starlight from "@astrojs/starlight"; import { defineConfig } from "astro/config"; -import { generateTypeDoc } from 'starlight-typedoc' +import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc"; -const typeDocSidebarGroup = await generateTypeDoc({ - entryPoints: ["../path/to/entry-point.ts"], - tsconfig: "../path/to/tsconfig.json", -}); export default defineConfig({ // … integrations: [ starlight({ + plugins: [ + starlightTypeDoc({ + entryPoints: ["../path/to/entry-point.ts"], + tsconfig: "../path/to/tsconfig.json", + }), + ], sidebar: [ { label: "Guides", items: [{ label: "Example Guide", link: "/guides/example/" }], }, typeDocSidebarGroup, ], title: "My Docs", }), ], });
🚀 Features
🐞 Bug Fixes
View changes on GitHub
v0.6.0
🚨 Breaking Changes
- Add support for
typedoc-plugin-markdown
version4.0.0-next.21
which is now the minimum supported version - by @HiDeoo (2efe1)