Skip to content

Commit d480b77

Browse files
feat(typedoc): update to typedoc v0.28 (#306)
* feat(typedoc): update to typedoc v0.28 * Add changeset * Remove MarkdownRendererEvent
1 parent 59a3492 commit d480b77

File tree

5 files changed

+69
-58
lines changed

5 files changed

+69
-58
lines changed

.changeset/better-adults-cut.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@tanstack/config': minor
3+
'@tanstack/typedoc-config': minor
4+
---
5+
6+
feat: update to typedoc v0.28

.changeset/easy-icons-drive.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@tanstack/typedoc-config': minor
3+
'@tanstack/config': minor
4+
---
5+
6+
BREAKING: typedoc output is no longer lower-cased due to API changes
Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
import {
2-
MarkdownPageEvent,
3-
MarkdownRendererEvent,
4-
} from 'typedoc-plugin-markdown'
1+
import { MarkdownPageEvent } from 'typedoc-plugin-markdown'
52

63
/**
74
* @param {import("typedoc-plugin-markdown").MarkdownApplication} app
@@ -20,18 +17,4 @@ export function load(app) {
2017
'<!-- DO NOT EDIT: this page is autogenerated from the type comments -->\n\n'
2118
},
2219
)
23-
// Rename output files
24-
app.renderer.on(
25-
MarkdownRendererEvent.BEGIN,
26-
/**
27-
* @param {import("typedoc-plugin-markdown").MarkdownRendererEvent} renderer
28-
*/ (renderer) => {
29-
renderer.urls = renderer.urls?.map((urlMapping) => {
30-
const name = urlMapping.url.toLowerCase()
31-
urlMapping.url = name
32-
urlMapping.model.url = name
33-
return urlMapping
34-
})
35-
},
36-
)
3720
}

pnpm-lock.yaml

Lines changed: 53 additions & 37 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pnpm-workspace.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ catalog:
3939
simple-git: ^3.28.0
4040
tinyglobby: ^0.2.15
4141
type-fest: ^5.0.1
42-
typedoc: 0.27.9
43-
typedoc-plugin-frontmatter: 1.2.1
44-
typedoc-plugin-markdown: 4.4.2
42+
typedoc: 0.28.14
43+
typedoc-plugin-frontmatter: 1.3.0
44+
typedoc-plugin-markdown: 4.9.0
4545
typescript: ^5.9.2
4646
typescript-eslint: ^8.46.0
4747
vite: ^7.1.9

0 commit comments

Comments
 (0)