yapi/ydoc.json

{
    "name": "yapi",
    "dest": "static/doc",
    "examplePath": "./exampleCode",
    "defaultGrammar": "json",
    "instructionsInfoPath": "", //使用说明 内容路径 (需要配合JS-Component注释的@instructions使用)
    "instructionsUrlPath": "", //使用说明demo路径 (需要配合JS-Component注释的@instructions使用)
    "common": { // 通用默认配置，包括主页配置等
        "title": "yapi", //page title
        "footer": "&copy; 2016 <a href=\"http://ued.qunar.com/ymfe/\">YMFE</a> Team. Build by <a href=\"http://ued.qunar.com/ydoc/\">ydoc</a>.", // 通用尾
        "home": "YMFE", // logo
        "homeUrl": "http://ued.qunar.com/ymfe/" // logourl
    },
    "options": {
        "foldcode": true
    },
    "pages": [{
        "name": "index", // Page Name 会根据他生成 html 文件，例: index.html
        "title": "首页", // Page Title
         "homepage": { // 配置首页，样式区别于其他页面
            "version": "v3.0.0", // 版本信息将显示在banner底部
            "button": [{ // 按钮组将显示在banner底部
                "name": "开始",
                "href": "./start.html"
            },{
                "name": "Github",
                "href": "https://github.com/YMFE/ydoc"
            }],
            "intro": [{ // 首页的正文部分，数组项依次渲染，可重复使用
                "title": "为前端开发者设计的文档生成工具", // 介绍板块标题
                "desc": "YDoc让文档开发更简单高效，让开发者专注于程序本身，让项目代码更具可读性、可维护性。" // 介绍板块描述
            },{
                "title": "特性",
                "detail": {
                    "type": "thumbnail", // 三列布局的介绍板块
                    "content": [{ // 三列布局的内容，每项的key值非必需，但建议每列的key值一致
                        "name": "丰富、可扩展的API", // 板块名称
                        "src": "http://ojk406wln.bkt.clouddn.com/intro_muti.png", // 缩略图
                        "desc": "YDoc提供了非常详尽的API，扩展性较强，如果你希望添加某些功能，可以在<a href=\"https://github.com/YMFE/ydoc\" target=\"_blank\"> Github </a>上面提Issue。" // 描述
                    },{
                        "name": "基于注释/markdown",
                        "src": "http://ojk406wln.bkt.clouddn.com/intro_md.png",
                        "desc": "基于项目代码注释与markdown快速构建文档，二者亦可在同一页面中使用。"
                    },{
                        "name": "可配置主题",
                        "src": "http://ojk406wln.bkt.clouddn.com/intro_theme.png",
                        "desc": "官方提供多套主题，并且支持用户自定义开发主题。"
                    }]
                }
            }]
        },
        "banner": { // Banner 配置
            "title": "Yapi",
            "description": "高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
        },
        "content": "./README.md" // 内容(这里以markdown文件举例)
    },{
        "name": "interface", // Page Name 会根据他生成 html 文件，例: index.html
        "title": "接口管理", // Page Title
        "banner": { // Banner 配置
            "title": "Yapi",
            "description": "高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
        },
        "content": "./README.md" // 内容(这里以markdown文件举例)
    },{
        "name": "mock", // Page Name 会根据他生成 html 文件，例: index.html
        "title": "Mock功能", // Page Title
        "banner": { // Banner 配置
            "title": "Yapi",
            "description": "高效、易用、功能强大、的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。"
        },
        "content": "./README.md" // 内容(这里以markdown文件举例)
    },{
        "name": "api",
        "title": " ",
        "banner": {
            "title": "api",
            "description": "api文档"
        },
        "content": "./server/controllers/*.js",
        "options": {
            "type": "interface", // 类型，可选 component 和 lib，默认 component
            "source": true, // 是否生成源文件预览，默认 false
            "categories":["group","user","project", "interface"]
        }
    }]
}