Skip to content

Commit 7577551

Browse files
committed
chore(typedoc): use @boneskull/typedoc-plugin-mermaid
- fix escaping issue in `ARCHITECTURE.md`
1 parent 33d8e4d commit 7577551

4 files changed

Lines changed: 24 additions & 3 deletions

File tree

.config/typedoc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export default {
7272
'./typedoc-plugin-bargs.js',
7373
'typedoc-plugin-mdn-links',
7474
'typedoc-plugin-extras',
75-
'./typedoc-plugin-mermaid.js',
75+
'@boneskull/typedoc-plugin-mermaid',
7676
],
7777
preserveWatchOutput: true,
7878
router: 'kind-dir',

ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ flowchart TD
100100
end
101101
102102
subgraph parsers [Parser Layer]
103-
D["Parser<V, P>"]
103+
D["Parser#lt;V, P#gt;"]
104104
E["map(parser, transformFn)"]
105105
F["merge(parser1, parser2)"]
106106
end
@@ -282,7 +282,7 @@ flowchart TD
282282
end
283283
284284
subgraph output [Output]
285-
J["ParseResult<V, P>"]
285+
J["ParseResult#lt;V, P#gt;"]
286286
K["Handler execution"]
287287
end
288288

package-lock.json

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

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
"test:watch": "npm run test:base -- --watch \"test/*.test.ts\""
7979
},
8080
"devDependencies": {
81+
"@boneskull/typedoc-plugin-mermaid": "0.2.1",
8182
"@commitlint/cli": "20.2.0",
8283
"@commitlint/config-conventional": "20.2.0",
8384
"@eslint/js": "9.39.2",

0 commit comments

Comments
 (0)