From: Eduardo San Martin Morote Date: Wed, 7 Jun 2023 12:05:20 +0000 (+0200) Subject: docs: upgrade typedoc X-Git-Tag: v4.2.3~10 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=941b2131e80550009e5221d4db9f366b1fea3fd5;p=thirdparty%2Fvuejs%2Frouter.git docs: upgrade typedoc --- diff --git a/package.json b/package.json index d14a1fe7..fec665b8 100644 --- a/package.json +++ b/package.json @@ -34,8 +34,8 @@ "p-series": "^3.0.0", "prettier": "^2.8.8", "semver": "^7.5.1", - "typedoc": "^0.23.26", - "typedoc-plugin-markdown": "^3.14.0", + "typedoc": "^0.24.8", + "typedoc-plugin-markdown": "^3.15.3", "typescript": "~4.9.5", "yorkie": "^2.0.0" }, diff --git a/packages/docs/api/interfaces/NavigationGuard.md b/packages/docs/api/interfaces/NavigationGuard.md index 59f65bb1..b2859108 100644 --- a/packages/docs/api/interfaces/NavigationGuard.md +++ b/packages/docs/api/interfaces/NavigationGuard.md @@ -6,15 +6,15 @@ editLink: false # Interface: NavigationGuard +Navigation guard. See [Navigation +Guards](/guide/advanced/navigation-guards.md). + ## Callable %{#Callable}% ### NavigationGuard %{#Callable-NavigationGuard}% ▸ **NavigationGuard**(`to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\> -Navigation guard. See [Navigation -Guards](/guide/advanced/navigation-guards.md). - #### Parameters %{#Callable-NavigationGuard-Parameters}% | Name | Type | diff --git a/packages/docs/api/interfaces/NavigationGuardWithThis.md b/packages/docs/api/interfaces/NavigationGuardWithThis.md index 2799f4d1..a9bc50c8 100644 --- a/packages/docs/api/interfaces/NavigationGuardWithThis.md +++ b/packages/docs/api/interfaces/NavigationGuardWithThis.md @@ -6,6 +6,9 @@ editLink: false # Interface: NavigationGuardWithThis +Navigation guard. See [Navigation +Guards](/guide/advanced/navigation-guards.md). + ## Type parameters %{#Type-parameters}% | Name | @@ -18,9 +21,6 @@ editLink: false ▸ **NavigationGuardWithThis**(`this`, `to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\> -Navigation guard. See [Navigation -Guards](/guide/advanced/navigation-guards.md). - #### Parameters %{#Callable-NavigationGuardWithThis-Parameters}% | Name | Type | diff --git a/packages/docs/api/interfaces/RouterScrollBehavior.md b/packages/docs/api/interfaces/RouterScrollBehavior.md index ee3c2aff..134b1454 100644 --- a/packages/docs/api/interfaces/RouterScrollBehavior.md +++ b/packages/docs/api/interfaces/RouterScrollBehavior.md @@ -6,6 +6,8 @@ editLink: false # Interface: RouterScrollBehavior +Type of the `scrollBehavior` option that can be passed to `createRouter`. + ## Callable %{#Callable}% ### RouterScrollBehavior %{#Callable-RouterScrollBehavior}% diff --git a/packages/docs/run-typedoc.js b/packages/docs/run-typedoc.js index d50a7f88..720d5570 100644 --- a/packages/docs/run-typedoc.js +++ b/packages/docs/run-typedoc.js @@ -6,6 +6,7 @@ createTypeDocApp({ tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'), // entryPointStrategy: 'packages', githubPages: false, + plugin: ['typedoc-plugin-markdown'], disableSources: true, entryPoints: [path.resolve(__dirname, '../router/src/index.ts')], }).build() diff --git a/packages/docs/typedoc-markdown.js b/packages/docs/typedoc-markdown.js index f8ee0942..6cc4f04f 100644 --- a/packages/docs/typedoc-markdown.js +++ b/packages/docs/typedoc-markdown.js @@ -101,7 +101,7 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) { ) async function serve() { - app.bootstrap(options) + await app.bootstrapWithPlugins(options) app.convertAndWatch(handleProject) } @@ -112,7 +112,7 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) { ) { await fs.rm(options.out, { recursive: true }) } - app.bootstrap(options) + await app.bootstrapWithPlugins(options) const project = app.convert() return handleProject(project) } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index ff6c548f..27bf0e8e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -35,11 +35,11 @@ importers: specifier: ^7.5.1 version: 7.5.1 typedoc: - specifier: ^0.23.26 - version: 0.23.26(typescript@4.9.5) + specifier: ^0.24.8 + version: 0.24.8(typescript@4.9.5) typedoc-plugin-markdown: - specifier: ^3.14.0 - version: 3.14.0(typedoc@0.23.26) + specifier: ^3.15.3 + version: 3.15.3(typedoc@0.24.8) typescript: specifier: ~4.9.5 version: 4.9.5 @@ -4981,8 +4981,8 @@ packages: resolution: {integrity: sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==} dev: false - /marked@4.2.12: - resolution: {integrity: sha512-yr8hSKa3Fv4D3jdZmtMMPghgVt6TWbk86WQaWhDloQjRSQhMMYCAro7jP7VDJrjjdV8pxVxMssXS8B8Y5DZ5aw==} + /marked@4.3.0: + resolution: {integrity: sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==} engines: {node: '>= 12'} hasBin: true dev: true @@ -5078,15 +5078,15 @@ packages: brace-expansion: 2.0.1 dev: true - /minimatch@7.2.0: - resolution: {integrity: sha512-rMRHmwySzopAQjmWW6TkAKCEDKNaY/HuV/c2YkWWuWnfkTwApt0V4hnYzzPnZ/5Gcd2+8MPncSyuOGPl3xPvcg==} - engines: {node: '>=10'} + /minimatch@9.0.0: + resolution: {integrity: sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==} + engines: {node: '>=16 || 14 >=14.17'} dependencies: brace-expansion: 2.0.1 dev: true - /minimatch@9.0.0: - resolution: {integrity: sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==} + /minimatch@9.0.1: + resolution: {integrity: sha512-0jWhJpD/MdhPXwPuiRkCbfYfSKp2qnn2eOc279qI7f+osl/l+prKSrvhg157zSYvx/1nmgn2NqdT6k2Z7zSH9w==} engines: {node: '>=16 || 14 >=14.17'} dependencies: brace-expansion: 2.0.1 @@ -6092,15 +6092,6 @@ packages: engines: {node: '>=8'} dev: true - /shiki@0.14.1: - resolution: {integrity: sha512-+Jz4nBkCBe0mEDqo1eKRcCdjRtrCjozmcbTUjbPTX7OOJfEbTZzlUWlZtGe3Gb5oV1/jnojhG//YZc3rs9zSEw==} - dependencies: - ansi-sequence-parser: 1.1.0 - jsonc-parser: 3.2.0 - vscode-oniguruma: 1.7.0 - vscode-textmate: 8.0.0 - dev: true - /shiki@0.14.2: resolution: {integrity: sha512-ltSZlSLOuSY0M0Y75KA+ieRaZ0Trf5Wl3gutE7jzLuIcWxLp5i/uEnLoQWNvgKXQ5OMpGkJnVMRLAuzjc0LJ2A==} dependencies: @@ -6108,7 +6099,6 @@ packages: jsonc-parser: 3.2.0 vscode-oniguruma: 1.7.0 vscode-textmate: 8.0.0 - dev: false /sigmund@1.0.1: resolution: {integrity: sha512-fCvEXfh6NWpm+YSuY2bpXb/VIihqWA6hLsgboC+0nl71Q7N7o2eaCW8mJa/NLvQhs6jpd3VZV4UiUQlV6+lc8g==} @@ -6600,26 +6590,26 @@ packages: engines: {node: '>=8'} dev: true - /typedoc-plugin-markdown@3.14.0(typedoc@0.23.26): - resolution: {integrity: sha512-UyQLkLRkfTFhLdhSf3RRpA3nNInGn+k6sll2vRXjflaMNwQAAiB61SYbisNZTg16t4K1dt1bPQMMGLrxS0GZ0Q==} + /typedoc-plugin-markdown@3.15.3(typedoc@0.24.8): + resolution: {integrity: sha512-idntFYu3vfaY3eaD+w9DeRd0PmNGqGuNLKihPU9poxFGnATJYGn9dPtEhn2QrTdishFMg7jPXAhos+2T6YCWRQ==} peerDependencies: - typedoc: '>=0.23.0' + typedoc: '>=0.24.0' dependencies: handlebars: 4.7.7 - typedoc: 0.23.26(typescript@4.9.5) + typedoc: 0.24.8(typescript@4.9.5) dev: true - /typedoc@0.23.26(typescript@4.9.5): - resolution: {integrity: sha512-5m4KwR5tOLnk0OtMaRn9IdbeRM32uPemN9kur7YK9wFqx8U0CYrvO9aVq6ysdZSV1c824BTm+BuQl2Ze/k1HtA==} + /typedoc@0.24.8(typescript@4.9.5): + resolution: {integrity: sha512-ahJ6Cpcvxwaxfu4KtjA8qZNqS43wYt6JL27wYiIgl1vd38WW/KWX11YuAeZhuz9v+ttrutSsgK+XO1CjL1kA3w==} engines: {node: '>= 14.14'} hasBin: true peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x dependencies: lunr: 2.3.9 - marked: 4.2.12 - minimatch: 7.2.0 - shiki: 0.14.1 + marked: 4.3.0 + minimatch: 9.0.1 + shiki: 0.14.2 typescript: 4.9.5 dev: true