Starlight plugin to generate documentation from TypeScript using TypeDoc
MIT License
Bot releases are visible (Hide)
typedoc
version to 0.26.5
- by @HiDeoo (cc680)
Published by github-actions[bot] 3 months ago
typedoc-plugin-frontmatter
- by @HiDeoo (d16e0)
Published by github-actions[bot] 3 months ago
srcDir
option - by @charlesLoder and @HiDeoo (d8c4e)
Published by github-actions[bot] 4 months ago
typedoc-plugin-markdown
version to 4.0.0
- by @HiDeoo (cac8e)
Published by github-actions[bot] 5 months ago
Published by github-actions[bot] 5 months ago
Published by github-actions[bot] 6 months ago
typedoc-plugin-markdown
version to 4.0.0-next.59
- by @HiDeoo (47a1f)
Published by github-actions[bot] 6 months ago
@link
tags with the packages
entry point strategy - by @HiDeoo (2fb04)
Published by github-actions[bot] 6 months ago
typedoc-plugin-markdown
version to 4.0.0-next.54
- by @HiDeoo (78160)
typedoc-plugin-markdown
- by @HiDeoo (b2e40)
Published by github-actions[bot] 6 months ago
@link
tags with the packages
entry point strategy - by @HiDeoo (a7982)
Published by github-actions[bot] 7 months ago
@link
tags - by @HiDeoo (4b6c8)
Published by github-actions[bot] 8 months ago
@group
tag - by @HiDeoo (60bec)
Published by github-actions[bot] 10 months ago
packages
entry point strategy - by @HiDeoo (89552)
Published by github-actions[bot] 10 months ago
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",
}),
],
});
base
option - by @HiDeoo (9959e)
Published by github-actions[bot] about 1 year ago
typedoc-plugin-markdown
version 4.0.0-next.21
which is now the minimum supported version - by @HiDeoo (2efe1)
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
typedoc-plugin-markdown
options can now be properly overridden - by @lorenzolewis in https://github.com/HiDeoo/starlight-typedoc/issues/10
Published by github-actions[bot] about 1 year ago
typedoc-plugin-markdown
options types in TypeDocConfig
- by @HiDeoo (e7897)