Skip to content

Releases: HiDeoo/starlight-typedoc

v0.12.1

11 May 16:25
v0.12.1
875d341
Compare
Choose a tag to compare

   🐞 Bug Fixes

  • Fixes an issue preventing to use badges with generated sidebar groups  -  by @HiDeoo (c6a49)
    View changes on GitHub

v0.12.0

29 Apr 13:32
v0.12.0
f5dbcf8
Compare
Choose a tag to compare

   🚨 Breaking Changes

  • Bump minimum required typedoc-plugin-markdown version to 4.0.0-next.59  -  by @HiDeoo (47a1f)
    View changes on GitHub

v0.11.1

18 Apr 18:05
v0.11.1
5ce0374
Compare
Choose a tag to compare

   🐞 Bug Fixes

  • Fixes broken links with @link tags with the packages entry point strategy  -  by @HiDeoo (2fb04)
    View changes on GitHub

v0.11.0

15 Apr 18:22
v0.11.0
f03aaf9
Compare
Choose a tag to compare

   🚨 Breaking Changes

  • Bump minimum required typedoc-plugin-markdown version to 4.0.0-next.54  -  by @HiDeoo (78160)

   🐞 Bug Fixes

  • Fixes a link rendering issue with latest versions of typedoc-plugin-markdown  -  by @HiDeoo (b2e40)
    View changes on GitHub

v0.10.1

09 Apr 17:08
v0.10.1
55e4ef2
Compare
Choose a tag to compare

   🐞 Bug Fixes

  • Fixes broken links in block tag comments using @link tags with the packages entry point strategy  -  by @HiDeoo (a7982)
    View changes on GitHub

v0.10.0

23 Mar 16:48
v0.10.0
0d05b68
Compare
Choose a tag to compare

   🚀 Features

  • Adds support for running multiple instances of the plugin with different configurations  -  by @HiDeoo (7f0f9)

   🐞 Bug Fixes

  • Fixes broken links in block tag comments using @link tags  -  by @HiDeoo (4b6c8)
    View changes on GitHub

v0.9.0

09 Feb 16:04
v0.9.0
1ae4574
Compare
Choose a tag to compare

   🚨 Breaking Changes

  • Bump minimum required typedoc-plugin-markdown version to 4.0.0-next.45  -  by @HiDeoo (fab05)

   🐞 Bug Fixes

  • Fixes an issue with rendering empty sidebar groups when using the @group tag  -  by @HiDeoo (60bec)
    View changes on GitHub

v0.8.0

05 Jan 08:56
v0.8.0
0f47d83
Compare
Choose a tag to compare

   🚀 Features

  • Add support for packages entry point strategy  -  by @HiDeoo (89552)

   🐞 Bug Fixes

  • Prevent generation of empty references sidebar group  -  by @HiDeoo (e0217)
    View changes on GitHub

v0.7.0

19 Dec 17:50
v0.7.0
64d367a
Compare
Choose a tag to compare

   🚨 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

  • Update plugin output to closely match the output of Astro v4  -  by @HiDeoo (383d5)

   🐞 Bug Fixes

  • Fixes link issues when using the Astro base option  -  by @HiDeoo (9959e)
    View changes on GitHub

v0.6.0

26 Sep 11:09
v0.6.0
642e1e1
Compare
Choose a tag to compare

   🚨 Breaking Changes

    View changes on GitHub