starlight-typedoc

Starlight plugin to generate documentation from TypeScript using TypeDoc

MIT License

Downloads
4.3K
Stars
68

Bot releases are visible (Hide)

starlight-typedoc - v0.15.0 Latest Release

Published by github-actions[bot] 2 months ago

   🚨 Breaking Changes

  • Bumps minimum required typedoc version to 0.26.5  -  by @HiDeoo (cc680)

   🐞 Bug Fixes

  • Fixes a generation issue when using a custom frontmatter  -  by @HiDeoo (3dd03)
    View changes on GitHub
starlight-typedoc - v0.14.0

Published by github-actions[bot] 3 months ago

   🚀 Features

  • Adds support for customizing the frontmatter of generated pages using typedoc-plugin-frontmatter  -  by @HiDeoo (d16e0)
    View changes on GitHub
starlight-typedoc - v0.13.1

Published by github-actions[bot] 3 months ago

   🐞 Bug Fixes

  • Fixes generation issue with the Astro srcDir option  -  by @charlesLoder and @HiDeoo (d8c4e)
    View changes on GitHub
starlight-typedoc - v0.13.0

Published by github-actions[bot] 4 months ago

   🚨 Breaking Changes

  • Bump minimum required typedoc-plugin-markdown version to 4.0.0  -  by @HiDeoo (cac8e)
    View changes on GitHub
starlight-typedoc - v0.12.2

Published by github-actions[bot] 5 months ago

   🐞 Bug Fixes

  • Fixes various Windows path and links related issues  -  by @HiDeoo (6514c)
    View changes on GitHub
starlight-typedoc - v0.12.1

Published by github-actions[bot] 5 months ago

   🐞 Bug Fixes

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

Published by github-actions[bot] 6 months ago

   🚨 Breaking Changes

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

Published by github-actions[bot] 6 months ago

   🐞 Bug Fixes

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

Published by github-actions[bot] 6 months ago

   🚨 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
starlight-typedoc - v0.10.1

Published by github-actions[bot] 6 months ago

   🐞 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
starlight-typedoc - v0.10.0

Published by github-actions[bot] 7 months ago

   🚀 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
starlight-typedoc - v0.9.0

Published by github-actions[bot] 8 months ago

   🚨 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
starlight-typedoc - v0.8.0

Published by github-actions[bot] 10 months ago

   🚀 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
starlight-typedoc - v0.7.0

Published by github-actions[bot] 10 months ago

   🚨 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
starlight-typedoc - v0.6.0

Published by github-actions[bot] about 1 year ago

   🚨 Breaking Changes

  • Add support for typedoc-plugin-markdown version 4.0.0-next.21 which is now the minimum supported version  -  by @HiDeoo (2efe1)
    View changes on GitHub
starlight-typedoc - v0.5.0

Published by github-actions[bot] about 1 year ago

   🚨 Breaking Changes

  • Bump minimum required Astro version to 3.0 and Starlight to 0.9.0  -  by @HiDeoo (4f2e0)
  • Bump minimum required typedoc-plugin-markdown version to 4.0.0-next.20  -  by @HiDeoo (3eb6b)
    View changes on GitHub
starlight-typedoc - v0.4.0

Published by github-actions[bot] about 1 year ago

   🚨 Breaking Changes

    View changes on GitHub
starlight-typedoc - v0.3.3

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

  • Broken links in summary using @link tag  -  by @HiDeoo (cbb11)
    View changes on GitHub
starlight-typedoc - v0.3.2

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

    View changes on GitHub
starlight-typedoc - v0.3.1

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

  • Escape frontmatter title to prevent build error  -  by @lorenzolewis and @HiDeoo (d90fe)
  • Use typedoc-plugin-markdown options types in TypeDocConfig  -  by @HiDeoo (e7897)
    View changes on GitHub