Skip to content

Commit 941b213

Browse files
committed
docs: upgrade typedoc
1 parent 9a38818 commit 941b213

File tree

7 files changed

+34
-41
lines changed

7 files changed

+34
-41
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
"p-series": "^3.0.0",
3535
"prettier": "^2.8.8",
3636
"semver": "^7.5.1",
37-
"typedoc": "^0.23.26",
38-
"typedoc-plugin-markdown": "^3.14.0",
37+
"typedoc": "^0.24.8",
38+
"typedoc-plugin-markdown": "^3.15.3",
3939
"typescript": "~4.9.5",
4040
"yorkie": "^2.0.0"
4141
},

packages/docs/api/interfaces/NavigationGuard.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ editLink: false
66

77
# Interface: NavigationGuard
88

9+
Navigation guard. See [Navigation
10+
Guards](/guide/advanced/navigation-guards.md).
11+
912
## Callable %{#Callable}%
1013

1114
### NavigationGuard %{#Callable-NavigationGuard}%
1215

1316
**NavigationGuard**(`to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
1417

15-
Navigation guard. See [Navigation
16-
Guards](/guide/advanced/navigation-guards.md).
17-
1818
#### Parameters %{#Callable-NavigationGuard-Parameters}%
1919

2020
| Name | Type |

packages/docs/api/interfaces/NavigationGuardWithThis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ editLink: false
66

77
# Interface: NavigationGuardWithThis<T\>
88

9+
Navigation guard. See [Navigation
10+
Guards](/guide/advanced/navigation-guards.md).
11+
912
## Type parameters %{#Type-parameters}%
1013

1114
| Name |
@@ -18,9 +21,6 @@ editLink: false
1821

1922
**NavigationGuardWithThis**(`this`, `to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
2023

21-
Navigation guard. See [Navigation
22-
Guards](/guide/advanced/navigation-guards.md).
23-
2424
#### Parameters %{#Callable-NavigationGuardWithThis-Parameters}%
2525

2626
| Name | Type |

packages/docs/api/interfaces/RouterScrollBehavior.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ editLink: false
66

77
# Interface: RouterScrollBehavior
88

9+
Type of the `scrollBehavior` option that can be passed to `createRouter`.
10+
911
## Callable %{#Callable}%
1012

1113
### RouterScrollBehavior %{#Callable-RouterScrollBehavior}%

packages/docs/run-typedoc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ createTypeDocApp({
66
tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'),
77
// entryPointStrategy: 'packages',
88
githubPages: false,
9+
plugin: ['typedoc-plugin-markdown'],
910
disableSources: true,
1011
entryPoints: [path.resolve(__dirname, '../router/src/index.ts')],
1112
}).build()

packages/docs/typedoc-markdown.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
101101
)
102102

103103
async function serve() {
104-
app.bootstrap(options)
104+
await app.bootstrapWithPlugins(options)
105105
app.convertAndWatch(handleProject)
106106
}
107107

@@ -112,7 +112,7 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
112112
) {
113113
await fs.rm(options.out, { recursive: true })
114114
}
115-
app.bootstrap(options)
115+
await app.bootstrapWithPlugins(options)
116116
const project = app.convert()
117117
return handleProject(project)
118118
}

pnpm-lock.yaml

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

0 commit comments

Comments
 (0)