File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -26,19 +26,28 @@ export default defineConfig({
2626 label : 'English' ,
2727 lang : 'en-US' ,
2828 link : '/' ,
29+ themeConfig : {
30+ nav : [
31+ { text : 'Guide' , link : '/guide/getting-started' } ,
32+ { text : 'API' , link : '/api/' } ,
33+ { text : 'GitHub' , link : 'https://github.com/iamsomraj/vue-qs' } ,
34+ ] ,
35+ } ,
2936 } ,
3037 zh : {
3138 label : '简体中文' ,
3239 lang : 'zh-CN' ,
3340 link : '/zh/' ,
41+ themeConfig : {
42+ nav : [
43+ { text : '指南' , link : '/zh/guide/getting-started' } ,
44+ { text : 'API' , link : '/zh/api/' } ,
45+ { text : 'GitHub' , link : 'https://github.com/iamsomraj/vue-qs' } ,
46+ ] ,
47+ } ,
3448 } ,
3549 } ,
3650 themeConfig : {
37- nav : [
38- { text : 'Guide' , link : '/guide/getting-started' } ,
39- { text : 'API' , link : '/api/' } ,
40- { text : 'GitHub' , link : 'https://github.com/iamsomraj/vue-qs' } ,
41- ] ,
4251 sidebar : {
4352 '/guide/' : [
4453 {
@@ -69,6 +78,12 @@ export default defineConfig({
6978 ] ,
7079 } ,
7180 ] ,
81+ '/zh/api/' : [
82+ {
83+ text : 'API' ,
84+ items : [ { text : 'API 参考' , link : '/zh/api/' } ] ,
85+ } ,
86+ ] ,
7287 } ,
7388 socialLinks : [ { icon : 'github' , link : 'https://github.com/iamsomraj/vue-qs' } ] ,
7489 editLink : {
Original file line number Diff line number Diff line change 1+ # API 参考
2+
3+ API 文档目前仅提供英文版本。请访问主要的 API 文档以获取完整的参考资料。
4+
5+ [ 查看完整 API 文档(英文)] ( /api/ )
6+
7+ ## 主要功能
8+
9+ - ** 类型安全的查询参数** : 完全类型化的 URL 查询参数状态管理
10+ - ** Vue 3 集成** : 专为 Vue 3 Composition API 设计
11+ - ** 响应式** : 与 Vue 的响应式系统无缝集成
12+ - ** Vue Router 支持** : 内置 Vue Router 适配器
13+ - ** 自定义序列化器** : 支持自定义数据类型的序列化
14+
15+ ## 快速导航
16+
17+ 以下是一些重要的 API 类别(链接到英文文档):
18+
19+ ### 核心函数
20+
21+ - [ useQueryRef] ( /api/functions/useQueryRef.md ) - 创建响应式查询参数引用
22+ - [ useQueryReactive] ( /api/functions/useQueryReactive.md ) - 创建响应式查询参数对象
23+
24+ ### 适配器
25+
26+ - [ createVueRouterAdapter] ( /api/functions/createVueRouterAdapter.md ) - Vue Router 适配器
27+ - [ createHistoryAdapter] ( /api/functions/createHistoryAdapter.md ) - History API 适配器
28+
29+ ### 编解码器
30+
31+ - [ stringCodec] ( /api/variables/stringCodec.md ) - 字符串编解码器
32+ - [ numberCodec] ( /api/variables/numberCodec.md ) - 数字编解码器
33+ - [ booleanCodec] ( /api/variables/booleanCodec.md ) - 布尔值编解码器
34+ - [ dateISOCodec] ( /api/variables/dateISOCodec.md ) - ISO 日期编解码器
35+
36+ ### 工具函数
37+
38+ - [ createJsonCodec] ( /api/functions/createJsonCodec.md ) - 创建 JSON 编解码器
39+ - [ createArrayCodec] ( /api/functions/createArrayCodec.md ) - 创建数组编解码器
40+ - [ createEnumCodec] ( /api/functions/createEnumCodec.md ) - 创建枚举编解码器
41+
42+ ---
43+
44+ _ 完整的 API 文档请访问 [ 英文版本] ( /api/ ) _
You can’t perform that action at this time.
0 commit comments