[Doc] new theme

2019-05-15 20:53:04 +08:00
parent 3cae4288f2
commit d0f4169c86
130 changed files with 1460 additions and 1147 deletions
@@ -1,4 +1,6 @@
-## 开发指南
+# 开发指南
+
+### 介绍

 首先感谢你使用 Vant。

@@ -90,55 +92,3 @@ packages
 ├─ index.js       # 所有组件入口
 └─ index.less     # 所有组件样式
 ```
-
-### 组件文档
-
-组件文档采用 markdown 格式，内容包括使用示例以及 `API` 等。
-
-##### 1. 标题规范
-
-文档标题从 `h2`（即 `##` 标题 ）开始，每往下一级多加一个 `#` 号。
-
-##### 2. 组件描述
-
-大标题下面是对组件的一句话简要描述。
-
-##### 3. 使用指南
-
-如果组件需要使用指南，放在组件描述下方，另起一个二级标题。
-
-##### 4. 代码演示
-
-书写代码演示时，建议从简单用法开始介绍，不要上来就同时使用一大堆 API，会让人觉得难以上手。并且一个示例只演示一个 API 的使用方法，如无特殊需求不要在一个示例中同时演示多个 API 混合使用。
-
-```html
-<van-button :size="size">
-  Large
-</van-button>
-```
-
-```javascript
-export default {
-  data() {
-    return {
-      size: 'large'
-    };
-  }
-};
-```
-
-#### 5. API 说明
-
-组件的 API 说明以表格的形式书写，表格包含以下列：
-
-| 参数 | 说明 | 类型 | 默认值 |
-| ------------ | ------------- | -------- | ---------- |
-| visible | 是否可见 | `Boolean` | `false` |
-
-#### 6. Event 说明
-
-组件的 Event 说明，请以表格的形式书写，表格包含以下列：
-
-| 事件名 | 说明 | 参数 |
-|-----------|-----------|-----------|
-| click | 点击按钮时触发 | event：事件对象 |