Skip to content

Commit aba075a

Browse files
authored
docs(breadcrumbs): fix twoslash error when build docs (#353)
* fix breadcrumbs docs * update lockfile
1 parent af689a8 commit aba075a

File tree

5 files changed

+13
-2
lines changed

5 files changed

+13
-2
lines changed

docs/.vitepress/twoslashConfig.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ export const compilerOptions = {
5656
'@nolebase/vitepress-plugin-thumbnail-hash/*': [
5757
'../packages/vitepress-plugin-thumbnail-hash/src/*',
5858
],
59+
'@nolebase/vitepress-plugin-breadcrumbs/*': [
60+
'../packages/vitepress-plugin-breadcrumbs/src/*',
61+
],
5962
},
6063
resolveJsonModule: true,
6164
types: [

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"@nolebase/ui-asciinema": "workspace:^",
2424
"@nolebase/ui-rive-canvas": "workspace:^",
2525
"@nolebase/unconfig-vitepress": "workspace:^",
26+
"@nolebase/vitepress-plugin-breadcrumbs": "workspace:^",
2627
"@nolebase/vitepress-plugin-enhanced-mark": "workspace:^",
2728
"@nolebase/vitepress-plugin-enhanced-readabilities": "workspace:^",
2829
"@nolebase/vitepress-plugin-git-changelog": "workspace:^",

docs/pages/en/integrations/vitepress-plugin-breadcrumbs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In the VitePress configuration file (usually `docs/.vitepress/config.ts`, the fi
4949

5050
```typescript twoslash
5151
import { defineConfig } from 'vitepress'
52-
import { generateBreadcrumbsData } from '@nolebase/vitepress-plugin-breadcrumbs' // [!code ++]
52+
import { generateBreadcrumbsData } from '@nolebase/vitepress-plugin-breadcrumbs/vitepress' // [!code ++]
5353
5454
export default defineConfig({
5555
// Other configurations...
@@ -67,6 +67,8 @@ Then please add the Breadcrumbs plugin package name `@nolebase/vitepress-plugin-
6767
<!--@include: @/pages/en/snippets/configure-tsconfig.md-->
6868

6969
```typescript twoslash
70+
import { defineConfig } from 'vitepress'
71+
7072
// https://vitepress.dev/reference/site-config
7173
export default defineConfig({
7274
vite: { // [!code ++]

docs/pages/zh-CN/integrations/vitepress-plugin-breadcrumbs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ bun install @nolebase/vitepress-plugin-breadcrumbs
4949

5050
```typescript twoslash
5151
import { defineConfig } from 'vitepress'
52-
import { generateBreadcrumbsData } from '@nolebase/vitepress-plugin-breadcrumbs' // [!code ++]
52+
import { generateBreadcrumbsData } from '@nolebase/vitepress-plugin-breadcrumbs/vitepress' // [!code ++]
5353
5454
export default defineConfig({
5555
// 其它各种配置...
@@ -67,6 +67,8 @@ export default defineConfig({
6767
<!--@include: @/pages/zh-CN/snippets/configure-tsconfig.md-->
6868

6969
```typescript twoslash
70+
import { defineConfig } from 'vitepress'
71+
7072
// https://vitepress.dev/reference/site-config
7173
export default defineConfig({
7274
vite: { // [!code ++]

pnpm-lock.yaml

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

0 commit comments

Comments
 (0)