Skip to content

Commit 1cb7529

Browse files
committed
feat: setup more seo-friendly doc
1 parent b050533 commit 1cb7529

File tree

4 files changed

+1327
-41
lines changed

4 files changed

+1327
-41
lines changed

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ dist/
77
build/
88
*.tsbuildinfo
99

10-
# Documentation
11-
docs/
10+
# Documentation (generated)
11+
docs/api/
12+
docs/.vitepress/dist/
13+
docs/.vitepress/cache/
1214
README.repo.md
1315

1416
# Environment

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
"typecheck": "tsc --noEmit",
2929
"lint": "eslint .",
3030
"lint:fix": "eslint . --fix",
31-
"docs": "typedoc",
32-
"docs:watch": "typedoc --watch",
33-
"docs:serve": "typedoc && npx http-server docs -o",
31+
"docs": "typedoc && vitepress build docs",
32+
"docs:dev": "typedoc && vitepress dev docs",
33+
"docs:preview": "typedoc && vitepress build docs && vitepress preview docs",
3434
"changeset": "changeset",
3535
"version": "changeset version",
3636
"release": "pnpm build && changeset publish && git push --follow-tags",
@@ -101,8 +101,10 @@
101101
"eslint": "^9.39.2",
102102
"tsup": "^8.5.1",
103103
"typedoc": "^0.28.16",
104-
"typedoc-github-theme": "^0.4.0",
104+
"typedoc-plugin-markdown": "^4.11.0",
105+
"typedoc-vitepress-theme": "^1.1.2",
105106
"typescript": "^5.9.3",
107+
"vitepress": "^1.6.4",
106108
"vitest": "^4.0.18"
107109
},
108110
"peerDependencies": {

0 commit comments

Comments
 (0)