ydoc.json

{
  "name": "Yo",
  "dest": "./doc",
  "examplePath": "./demo/component",
  "defaultGrammar": "jsx",
  "instructionsInfoPath": "./docs/component",
  "instructionsUrlPath": "//ued.qunar.com/hy2/yo/demo/src/html/component/",
  "options": {
    "foldsidenav": false,
    "staticsidenav": true,
    "hasPageName": true
  },
  "resources": {
    "styles": "./docs/theme/styles",
    "scripts": "./docs/theme/scripts"
  },
  "common": {
    "title": "Yo Documentation",
    "footer": "&copy; 2018 <a href=\"https://github.com/YMFE\">YMFE</a> Team. Build by <a href=\"https://github.com/YMFE/ydoc\">ydoc</a>.",
    "home": "YMFE",
    "homeUrl": "https://ymfe.org/",
    "navbars": []
  },
  "pages": [
    {
      "name": "index",
      "title": "Yo",
      "homepage": {
          "version": "v3.1.0",
          "button": [{
              "name": "起步",
              "href": "./getting-started.html"
          },{
              "name": "Github",
              "href": "https://github.com/doyoe/Yo"
          }]
      },
      "banner": {
        "title": "Yo",
        "description": "Yo 是一个专注于移动开发的 Front-end UI Framework，她轻量，易用，可配置，并且具备超强的扩展能力。"
      },
      "content": "./case.md"
    },
    {
      "name": "getting-started",
      "title": "起步",
      "banner": {
        "title": "起步",
        "description": "本文详细描述 Yo 的使用方式，花上几分钟，下述的介绍将会帮助你快速的上手，并让自己沉浸在使用 Yo 的开发之中，感受到乐趣"
      },
      "content": {
        "type": "blocks",
        "sidebar": true,
        "multi": true,
        "index": "./docs/start.md",
        "pages": [
          {
            "name": "起步",
            "content": "./docs/start.md",
            "index": "start"
          },
          {
            "name": "3.1.0 升级指南",
            "content": "./docs/update-to-3.1.0.md",
            "index": "update-to-3.1.0"
          },
          {
            "name": "附录一：在已有项目中使用",
            "content": "./docs/start-diy.md",
            "index": "start-diy"
          },
          {
            "name": "附录二：关于 chunk 模式",
            "content": "./docs/start-chunk.md",
            "index": "start-chunk"
          },
          {
            "name": "附录三：关于 lib.js",
            "content": "./docs/start-lib.md",
            "index": "start-lib"
          },
          {
            "name": "附录四：关于 npm 低版本",
            "content": "./docs/start-npm.md",
            "index": "start-npm"
          },
          {
            "name": "附录五：Yo 的体积",
            "content": "./docs/start-size.md",
            "index": "start-size"
          }
        ]
      }
    },
    {
      "name": "core",
      "title": "核心",
      "banner": {
        "title": "核心",
        "description": "Yo 提供了非常多的方法，以供大家方便的实现某些常用的功能，比如处理厂商前缀，1像素边框，响应式等。同时，Yo 还为 sass List 扩展了更多的函数，大家可以更方便的操作 List 了。"
      },
      "content": "./style/lib/core/**/*.scss",
      "compile": "css",
      "options": {
        "source": true
      }
    },
    {
      "name": "element",
      "title": "元件",
      "banner": {
        "title": "元件",
        "description": "Yo 将每个独立的、通用的 scss 代码片段抽象成元件。这些元件以一个个独立的模块形式存在，这意味着你可以按需引用任何一个元件。更有趣的是，每个元件都拥有一个同名方法，允许你通过传参来改变任意元件本身的外观。"
      },
      "content": "./style/lib/+(element|fragment|layout|widget)/*.scss",
      "compile": "css",
      "options": {
        "source": true
      }
    },
    {
      "name": "component",
      "title": "组件",
      "banner": {
        "title": "组件",
        "description": "组件的说明文档"
      },
      "content": {
        "type": "blocks",
        "sidebar": true,
        "multi": true,
        "index": "./component_dev/touchable/src/touchable.js",
        "pages": [
          {
            "name": "Touchable",
            "content": "./component_dev/touchable/src/touchable.js"
          },
          {
            "name": "LazyImage",
            "content": "./component_dev/lazyimage/index.js"
          },
          {
            "name": "Sticky",
            "content": "./component_dev/sticky/index.js"
          },
          {
            "name": "滚动和列表"
          },
          {
            "name": "Scroller",
            "content": "./component_dev/scroller/src/scroller.js",
            "sub": true
          },
          {
            "name": "List",
            "content": "./component_dev/list/src/list.js",
            "sub": true
          },
          {
            "name": "Grouplist",
            "content": "./component_dev/grouplist/src/grouplist.js",
            "sub": true
          },
          {
            "name": "SwipeMenuList",
            "content": "./component_dev/swipemenulist/src/swipemenulist.js",
            "sub": true
          },
          {
            "name": "MultiList",
            "content": "./component_dev/multilist/src/multilist.js",
            "sub": true
          },
          {
            "name": "弹层"
          },
          {
            "name": "Modal",
            "content": "./component_dev/modal/src/realmodal.js",
            "sub": true
          },
          {
            "name": "Dialog",
            "content": "./component_dev/dialog/src/dialog.js",
            "sub": true
          },
          {
            "name": "Popup",
            "content": "./component_dev/popup/src/popup.js",
            "sub": true
          },
          {
            "name": "表单元素"
          },
          {
            "name": "Picker",
            "content": "./component_dev/picker/src/picker.js",
            "sub": true
          },
          {
            "name": "DateTimePicker",
            "content": "./component_dev/datetimepicker/src/datetimepicker.js",
            "sub": true
          },
          {
            "name": "PopupPicker",
            "content": "./component_dev/popuppicker/src/popuppicker.js",
            "sub": true
          },
          {
            "name": "PopupDateTimePicker",
            "content": "./component_dev/popupdatetimepicker/src/popupdatetimepicker.js",
            "sub": true
          },
          {
            "name": "Rating",
            "content": "./component_dev/rating/src/rating.js",
            "sub": true
          },
          {
            "name": "Switch",
            "content": "./component_dev/switch/src/switch.js",
            "sub": true
          },
          {
            "name": "InputNumber",
            "content": "./component_dev/inputnumber/src/inputnumber.js",
            "sub": true
          },
          {
            "name": "其他"
          },
          {
            "name": "Calendar",
            "content": "./component_dev/calendar/src/calendar.js",
            "sub": true
          },
          {
            "name": "Carousel",
            "content": "./component_dev/carousel/src/carousel.js",
            "sub": true
          },
          {
            "name": "Carousel.CarouselItem",
            "content": "./component_dev/carousel/src/carouselItem.js",
            "sub": true
          },
          {
            "name": "Range",
            "content": "./component_dev/range/src/range.js",
            "sub": true
          },
          {
            "name": "SwipeMenu",
            "content": "./component_dev/swipemenu/src/swipemenu.js",
            "sub": true
          },
          {
            "name": "Suggest",
            "content": "./component_dev/suggest/src/suggest.js",
            "sub": true
          },
          {
            "name": "Loading",
            "content": "./component_dev/loading/src/loading.js",
            "sub": true
          },
          {
            "name": "API"
          },
          {
            "name": "ActionSheet",
            "content": "./component_dev/actionsheet/src/actionsheet.js",
            "sub": true
          },
          {
            "name": "Alert",
            "content": "./component_dev/alert/src/alert.js",
            "sub": true
          },
          {
            "name": "Confirm",
            "content": "./component_dev/confirm/src/confirm.js",
            "sub": true
          },
          {
            "name": "Loading（API）",
            "content": "./component_dev/loading/src/loadingAPI.js",
            "sub": true
          },
          {
            "name": "Toast",
            "content": "./component_dev/toast/src/toast.js",
            "sub": true
          }
        ]
      }
    },
    {
      "name": "animate",
      "title": "动画",
      "banner": {
        "title": "动画",
        "description": "Yo 精心准备了超过60款动画形态，可以随意组合或者单独使用。可以像使用元件那样，按需引用你所需要的动画形态。"
      },
      "content": "./style/lib/ani/*.scss",
      "compile": "css",
      "options": {
        "source": true
      }
    },
    {
      "name": "route",
      "title": "Router",
      "url": "http://ued.qunar.com/hy2/yo-router"
    },
    {
      "name": "changelog",
      "title": "版本",
      "banner": {
        "title": "版本",
        "description": "Yo 的历史版本发布时间及变更记录，帮助你追溯到每个版本的演进过程。"
      },
      "content": "./changelog.md"
    },
    {
      "name": "demo",
      "title": "示例",
      "url": "http://ued.qunar.com/hy2/yo/demo/src/html/index.html"
    }
  ]
}