yapi/ydoc.json

180 lines
5.8 KiB
JSON
Raw Normal View History

2017-07-06 19:21:54 +08:00
{
2017-07-28 23:31:35 +08:00
"name": "YApi",
2017-07-28 21:13:51 +08:00
"dest": "static/doc",
2017-07-06 19:21:54 +08:00
"examplePath": "./exampleCode",
"defaultGrammar": "json",
"instructionsInfoPath": "", //使用说明 内容路径 (需要配合JS-Component注释的@instructions使用)
"instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用)
"common": { // 通用默认配置,包括主页配置等
2017-07-28 23:31:35 +08:00
"title": "YApi", //page title
"footer": "&copy; 2016 <a href=\"https://github.com/ymfe/yapi\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a>", // 通用尾
2017-07-06 19:21:54 +08:00
"home": "YMFE", // logo
"homeUrl": "https://github.com/ymfe" // logourl
2017-07-06 19:21:54 +08:00
},
"options": {
2017-10-10 10:25:50 +08:00
"foldcode": false,
2017-08-30 15:53:48 +08:00
"markdown": { // 对于 markdown 编译器进行统一配置
"menuLevel": 2 //选取第几级 head 作为目录,默认 -1 没有目录
}
2017-07-06 19:21:54 +08:00
},
"pages": [{
2017-09-12 11:58:22 +08:00
"name": "index",
2017-08-31 17:08:28 +08:00
"title": "使用手册",
2017-08-31 11:55:24 +08:00
"banner": {
2017-07-28 23:31:35 +08:00
"title": "YApi",
2017-09-01 15:59:53 +08:00
"description": "高效、易用、功能强大的api管理平台旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
2017-07-06 19:21:54 +08:00
},
2017-08-31 11:55:24 +08:00
"content": {
"sidebar": true,
"multi": true,
2017-09-05 11:16:06 +08:00
"index": "./doc/page/usage/getfamiliar.md",
2017-08-31 11:55:24 +08:00
"pages": [{
"name": "认识 YApi",
2017-09-21 15:14:41 +08:00
"index": "getfamiliar",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/getfamiliar.md"
},{
2017-08-31 11:55:24 +08:00
"name": "创建第一个API",
2017-09-21 15:14:41 +08:00
"index": "quickstart",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/quickstart.md"
2017-09-04 11:50:36 +08:00
},{
2017-09-06 15:40:45 +08:00
"name": "管理分组与项目",
2017-09-21 15:14:41 +08:00
"index": "manage",
2017-09-06 15:40:45 +08:00
"content": "./doc/page/usage/manage.md"
},{
"name": "项目操作",
2017-09-21 15:14:41 +08:00
"index": "project",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/project.md"
},{
2017-09-06 15:40:45 +08:00
"name": "接口操作",
2017-09-21 15:14:41 +08:00
"index": "interface",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/api.md"
2017-09-04 11:50:36 +08:00
},{
2017-10-25 17:20:55 +08:00
"name": "普通 Mock",
2017-09-21 15:14:41 +08:00
"index": "mock",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/mock.md"
2017-10-25 17:20:55 +08:00
},{
"name": "高级 Mock",
"index": "adv_mock",
"content": "./doc/page/usage/adv_mock.md"
2017-09-05 11:16:06 +08:00
},{
2017-09-04 11:50:36 +08:00
"name": "使用测试集",
2017-09-21 15:14:41 +08:00
"index": "case",
2017-09-05 11:16:06 +08:00
"content": "./doc/page/usage/case.md"
2017-09-15 21:02:45 +08:00
},{
2017-09-21 15:14:41 +08:00
"name": "数据导入",
"index": "data",
2017-09-15 21:02:45 +08:00
"content": "./doc/page/usage/data.md"
2017-09-04 11:50:36 +08:00
}
2017-09-01 15:59:53 +08:00
]
2017-08-31 11:55:24 +08:00
}
2017-08-31 17:08:28 +08:00
},
2017-09-07 18:44:50 +08:00
// {
// "name": "manage",
// "title": "管理学院",
// "banner": {
// "title": "管理学院",
// "description": "超级管理员、分组/项目组长的学院。"
// },
// "content": {
// "sidebar": true,
// "multi": true,
// "index": "./doc/page/manage/intro.md",
// "pages": [{
// "name": "介绍",
// "content": "./doc/page/manage/intro.md"
// }, {
// "name": "部署",
// "content": "./doc/page/manage/build.md"
// }, {
// "name": "超管职责",
// "content": "./doc/page/manage/admin.md"
// }, {
// "name": "版本升级",
// "content": "./doc/page/manage/update.md"
// }]
// }
// },
2017-10-10 10:25:50 +08:00
{
"name": "devops",
"title": "内网部署",
// "banner": {
// "title": "YApi",
// "description": "这里列举了 YApi 的历史版本、发布时间及变更记录,帮助你追溯到每个版本的演进过程。"
// },
"compile": "markdown",
"menuLevel": 2,
"content": "./doc/page/manage/build.md"
2017-10-11 16:09:25 +08:00
},
{
"name": "plugin",
"title": "插件Wiki",
"banner": {
"title": "插件",
"description": "可根据业务需求,定制化功能"
},
"content": {
"sidebar": true,
"multi": true,
"index": "./doc/page/plugin/index.md",
"pages": [{
"name": "插件管理",
"index": "plugin-index",
"content": "./doc/page/plugin/index.md"
},{
"name": "插件开发",
"index": "plugin-dev",
"content": "./doc/page/plugin/dev.md"
},{
"name": "钩子列表",
"index": "plugin-hooks",
"content": "./doc/page/plugin/hooks.md"
},{
"name": "插件列表",
"index": "plugin-list",
"content": "./doc/page/plugin/list.md"
}
]
}
2017-10-10 10:25:50 +08:00
},
2017-10-20 10:54:08 +08:00
{
"name": "qa",
"title": "常见问题",
"compile": "markdown",
"menuLevel": 2,
"content": "./doc/page/usage/qa.md"
},
2017-09-18 10:10:31 +08:00
{
"name": "releases",
"title": "版本记录",
"banner": {
"title": "YApi",
2017-09-20 15:39:55 +08:00
"description": "这里列举了 YApi 的历史版本、发布时间及变更记录,帮助你追溯到每个版本的演进过程。"
2017-09-18 10:10:31 +08:00
},
"compile": "markdown",
"menuLevel": 2,
"content": "./CHANGELOG.md"
2017-09-29 22:11:58 +08:00
},{
2017-10-14 13:33:35 +08:00
"name": "demo站点",
"title": "demo站点",
2017-09-29 22:11:58 +08:00
"url": "http://yapi.demo.qunar.com/"
2017-09-18 10:10:31 +08:00
},
2017-08-31 17:08:28 +08:00
{
2017-07-06 19:21:54 +08:00
"name": "api",
2017-07-28 23:31:35 +08:00
"title": "",
2017-07-06 19:21:54 +08:00
"banner": {
"title": "api",
"description": "api文档"
},
2017-10-16 15:38:29 +08:00
"content": "./server/controllers/+(follow|base|group|interface|interfaceCol|log|project|user).js",
2017-07-06 19:21:54 +08:00
"options": {
2017-08-31 17:08:28 +08:00
"type": "interface",
"source": true,
2017-08-11 16:16:16 +08:00
"categories":["group","user","project", "interface","follow"]
2017-07-06 19:21:54 +08:00
}
2017-08-21 21:18:29 +08:00
}],
"resources": {
2017-08-31 17:08:28 +08:00
"images": "./doc/images",
"styles": "./doc/styles"
2017-08-21 21:18:29 +08:00
}
2017-07-06 19:21:54 +08:00
}