fix!: bump minimum required typedoc-plugin-markdown version to `4.0…

….0-next.59`

docs/src/content/docs/getting-started.mdx

@@ -56,7 +56,7 @@ ni starlight-typedoc typedoc typedoc-plugin-markdown@next
 </Tabs>
 
 :::note
-The Starlight TypeDoc package requires at least the version `4.0.0-next.54` of `typedoc-plugin-markdown`, hence the `@next` tag in the installation command.
+The Starlight TypeDoc package requires at least the version `4.0.0-next.59` of `typedoc-plugin-markdown`, hence the `@next` tag in the installation command.
 :::
 
 ## Add the plugin

example/package.json

@@ -23,7 +23,7 @@
     "sharp": "0.32.6",
     "starlight-typedoc": "workspace:*",
     "typedoc": "0.25",
-    "typedoc-plugin-markdown": "4.0.0-next.54",
+    "typedoc-plugin-markdown": "4.0.0-next.59",
     "typedoc-plugin-mdn-links": "3.0.3"
   },
   "engines": {

packages/starlight-typedoc/libs/theme.ts

@@ -8,7 +8,7 @@ import {
   type PageEvent,
   type CommentDisplayPart,
 } from 'typedoc'
-import { MarkdownTheme, MarkdownThemeRenderContext } from 'typedoc-plugin-markdown'
+import { MarkdownTheme, MarkdownThemeContext } from 'typedoc-plugin-markdown'
 
 import { getAsideMarkdown, getRelativeURL } from './starlight'
 
@@ -21,27 +21,23 @@ export class StarlightTypeDocTheme extends MarkdownTheme {
   }
 }
 
-class StarlightTypeDocThemeRenderContext extends MarkdownThemeRenderContext {
-  #markdownThemeRenderContext: MarkdownThemeRenderContext
+class StarlightTypeDocThemeRenderContext extends MarkdownThemeContext {
+  #markdownThemeContext: MarkdownThemeContext
 
   constructor(theme: MarkdownTheme, event: PageEvent<Reflection>, options: Options) {
     super(theme, event, options)
 
-    this.#markdownThemeRenderContext = new MarkdownThemeRenderContext(theme, event, options)
+    this.#markdownThemeContext = new MarkdownThemeContext(theme, event, options)
   }
 
-  override helpers: MarkdownThemeRenderContext['helpers'] = {
-    // @ts-expect-error https://github.com/tgreyuk/typedoc-plugin-markdown/blob/2bc4136a364c1d1ab44789d6148cd19c425ce63c/docs/pages/docs/customizing-output.mdx#custom-theme
-    ...this.helpers,
-    getRelativeUrl: (url: string) => {
-      const outputDirectory = this.options.getValue('starlight-typedoc-output')
-      const baseUrl = typeof outputDirectory === 'string' ? outputDirectory : ''
+  override getRelativeUrl(url: string): string {
+    const outputDirectory = this.options.getValue('starlight-typedoc-output')
+    const baseUrl = typeof outputDirectory === 'string' ? outputDirectory : ''
 
-      return getRelativeURL(url, baseUrl, this.page.url)
-    },
+    return getRelativeURL(url, baseUrl, this.page.url)
   }
 
-  override partials: MarkdownThemeRenderContext['partials'] = {
+  override partials: MarkdownThemeContext['partials'] = {
     // @ts-expect-error https://github.com/tgreyuk/typedoc-plugin-markdown/blob/2bc4136a364c1d1ab44789d6148cd19c425ce63c/docs/pages/docs/customizing-output.mdx#custom-theme
     ...this.partials,
     comment: (comment, options) => {
@@ -70,7 +66,7 @@ class StarlightTypeDocThemeRenderContext extends MarkdownThemeRenderContext {
 
       filteredComment.summary = comment.summary.map((part) => this.#parseCommentDisplayPart(part))
 
-      let markdown = this.#markdownThemeRenderContext.partials.comment(filteredComment, options)
+      let markdown = this.#markdownThemeContext.partials.comment(filteredComment, options)
 
       if (options?.showSummary === false) {
         return markdown
@@ -110,7 +106,7 @@ class StarlightTypeDocThemeRenderContext extends MarkdownThemeRenderContext {
     ) {
       return {
         ...part,
-        target: this.helpers.getRelativeUrl(
+        target: this.getRelativeUrl(
           path.posix.join(this.options.getValue('entryPointStrategy') === 'packages' ? '../..' : '..', part.target.url),
         ),
       }

packages/starlight-typedoc/libs/typedoc.ts

@@ -29,7 +29,6 @@ const defaultTypeDocConfig: TypeDocConfig = {
 
 const markdownPluginConfig: TypeDocConfig = {
   hideBreadcrumbs: true,
-  hideInPageTOC: true,
   hidePageHeader: true,
   hidePageTitle: true,
 }
@@ -88,6 +87,7 @@ async function bootstrapApp(
   })
   app.logger = new StarlightTypeDocLogger(logger)
   app.options.addReader(new TSConfigReader())
+  // @ts-expect-error - Invalid theme typing
   app.renderer.defineTheme('starlight-typedoc', StarlightTypeDocTheme)
   app.renderer.on(PageEvent.END, (event: PageEvent<DeclarationReflection>) => {
     onRendererPageEnd(event, pagination)

packages/starlight-typedoc/package.json

@@ -37,7 +37,7 @@
     "@astrojs/starlight": ">=0.15.0",
     "astro": ">=4.0.0",
     "typedoc": ">=0.25.0",
-    "typedoc-plugin-markdown": ">=4.0.0-next.54"
+    "typedoc-plugin-markdown": ">=4.0.0-next.59"
   },
   "engines": {
     "node": ">=18.14.1"

packages/starlight-typedoc/tests/e2e/basics/content.test.ts

@@ -65,7 +65,7 @@ test('should disable edit links', async ({ docPage }) => {
 test('should support TypeDoc plugins', async ({ docPage }) => {
   await docPage.goto('classes/foo')
 
-  const mdnLink = docPage.page.getByRole('link', { exact: true, name: 'HTMLElement' })
+  const mdnLink = docPage.page.getByRole('link', { exact: true, name: 'HTMLElement ↗️' })
 
   await expect(mdnLink).toBeVisible()