Skip to content

Commit d505e27

Browse files
committed
docs: optimizing the navigation of API documentation
1 parent 37023fd commit d505e27

File tree

2 files changed

+12
-21
lines changed

2 files changed

+12
-21
lines changed

docs/.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export default defineConfig({
1414
nav: [
1515
{ text: "首页", link: "/" },
1616
{ text: "指南", link: "/guides/introduction" },
17-
{ text: "API 文档", link: "/api/" },
17+
{ text: "API", link: "/api" },
1818
],
1919
sidebar: {
2020
"/guides/": [

typedoc.json

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,19 @@
11
{
22
"name": "api-morph",
3-
"entryPoints": ["src/index.ts"],
3+
"entryPoints": ["src/index.ts", "src/express/index.ts"],
44
"out": "docs/api",
5+
"docsRoot": "docs",
56
"plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
6-
"exclude": [
7-
"**/*.test.ts",
8-
"**/*.spec.ts",
9-
"**/node_modules/**",
10-
"**/__tests__/**",
11-
"**/__snapshots__/**"
12-
],
7+
"exclude": ["**/node_modules/**"],
138
"readme": "none",
14-
"excludePrivate": true,
15-
"excludeProtected": true,
16-
"excludeInternal": true,
17-
"hideGenerator": true,
18-
"categorizeByGroup": true,
19-
"defaultCategory": "其他",
20-
"categoryOrder": ["核心", "解析器", "构建器", "分析器", "帮助工具", "类型定义", "其他"],
219
"gitRevision": "main",
2210
"sourceLinkTemplate": "https://github.com/yingzhi0808/api-morph/blob/{gitRevision}/{path}#L{line}",
23-
"docsRoot": "docs",
24-
"sidebar": {
25-
"autoConfiguration": true,
26-
"format": "vitepress"
27-
}
11+
"hideBreadcrumbs": true,
12+
"navigation": {
13+
"includeGroups": false,
14+
"includeCategories": true
15+
},
16+
"indexFormat": "table",
17+
"expandParameters": true,
18+
"categoryOrder": ["Core", "Builders", "Parsers", "Analyzers", "Types", "Express"]
2819
}

0 commit comments

Comments
 (0)