{ "name": "YApi", "dest": "static/doc", "examplePath": "./exampleCode", "defaultGrammar": "json", "instructionsInfoPath": "", //使用说明 内容路径 (需要配合JS-Component注释的@instructions使用) "instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用) "common": { // 通用默认配置,包括主页配置等 "title": "YApi", //page title "footer": "© 2016 YMFE Team. Build by ydoc.", // 通用尾 "home": "YMFE", // logo "homeUrl": "http://ued.qunar.com/ymfe/" // logourl }, "options": { "foldcode": true, "markdown": { // 对于 markdown 编译器进行统一配置 "menuLevel": 2 //选取第几级 head 作为目录,默认 -1 没有目录 } }, "pages": [{ "name": "index", // Page Name 会根据他生成 html 文件,例: index.html "title": "首页", // Page Title "homepage": { // 配置首页,样式区别于其他页面 "version": "v1.0.0", // 版本信息将显示在banner底部 "button": [{ // 按钮组将显示在banner底部 "name": "开始", "href": "./start.html" },{ "name": "Github", "href": "https://github.com/YMFE/yapi" }], "intro": [{ // 首页的正文部分,数组项依次渲染,可重复使用 "title": "为API开发者设计的管理平台", // 介绍板块标题 "desc": "YApi让接口开发更简单高效,让接口的管理更具可读性、可维护性,让团队协作更合理。" // 介绍板块描述 },{ "title": "功能", "detail": { "type": "thumbnail", // 三列布局的介绍板块 "content": [{ // 三列布局的内容,每项的key值非必需,但建议每列的key值一致 "name": "项目管理", // 板块名称 "src": "http://ojk406wln.bkt.clouddn.com/intro_muti.png", // 缩略图 "desc": "YApi成熟的团队管理,扁平化项目权限配置满足各类企业的需求" // 描述 },{ "name": "接口管理", "src": "http://ojk406wln.bkt.clouddn.com/intro_md.png", "desc": "友好的接口文档,基于websocket的多人协作接口编辑功能和类postman测试工具,让多人协作成倍提升开发效率" },{ "name": "MockServer", "src": "http://ojk406wln.bkt.clouddn.com/intro_theme.png", "desc": "基于Mockjs,使用简单功能强大" }] } }] }, "banner": { "title": "YApi", "description": "高效、易用、功能强大的api管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。" }, "content": "./doc/home.md" },{ "name": "usage", "title": "使用手册", "banner": { "title": "YApi", "description": "高效、易用、功能强大的api管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。" }, "content": { "sidebar": true, "multi": true, "index": "./doc/page/usage/getfamiliar.md", "pages": [{ "name": "认识 YApi", "content": "./doc/page/usage/getfamiliar.md" },{ "name": "创建第一个API", "content": "./doc/page/usage/quickstart.md" },{ "name": "项目管理", "content": "./doc/page/usage/project.md" },{ "name": "接口配置与调试", "content": "./doc/page/usage/api.md" },{ "name": "使用mock功能", "content": "./doc/page/usage/mock.md" },{ "name": "使用测试集", "content": "./doc/page/usage/case.md" } ] } }, { "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" }] } }, { "name": "api", "title": "", "banner": { "title": "api", "description": "api文档" }, "content": "./server/controllers/*.js", "options": { "type": "interface", "source": true, "categories":["group","user","project", "interface","follow"] } }], "resources": { "images": "./doc/images", "styles": "./doc/styles" } }