add doc

Author: Allenice

docs/Build Command.md

@@ -0,0 +1,49 @@
+# 构建命令
+```bash
+# 开发模式
+npm run dev
+
+# 构建开发环境
+npm run build:dev
+
+# 构建 sit 环境
+npm run build:sit
+
+# 构建 deploy 环境
+npm run deploy
+
+# 生成 svg 图标
+npm run svg
+
+```
+
+## 添加组件
+使用 **./tools/cli.js** 添加组件。
+```text
+选项：
+  --version, -v  显示版本号                                               [布尔]
+  --help, -h     显示帮助信息                                             [布尔]
+  --type, -t     The component type
+                                  [可选值: "view", "ui", "tag"] [默认值: "view"]
+  --path, -p     The target path                      [默认值: "src/components"]
+```
+```bash
+# 添加组件, 
+./tools/cli.js add [componentName] -t [componentType]
+
+# 如果只是添加 view, 而且已经安装 yarn
+yarn cli add [componentName] -t [componentType]
+```
+
+componentName 可以是路径
+```bash
+./tools/cli.js add public/login -t view
+```
+以上会在 src/components/views/public/login 创建一个 view 类型的组件。
+##### 
+**-p** 参数是指定根路径。如果你要创建的组件不在 **src/components**, 你可以通过设置该参数改变根路径。
+
+```bash
+./tools/cli.js add hello -t tag -p demo/components
+```
+以上会在 demo/components/tags/hello 创建一个 tag 类型的组件。

docs/Project Structure.md

@@ -0,0 +1,43 @@
+# Project Structure
+```text
+.
+├── build                   # 项目构建配置目录
+│   ├── config              # 开发模式和生产模式配置
+│   │   ├── index.js
+│   ├── tpl                 # html 模板
+│   │   └── index.html
+│   └── ...
+├── src
+│   ├── api                 # 后端接口配置
+│   │   ├── http.ts
+│   │   ├── index.ts
+│   │   └── modules         # 后端接口模块
+│   │       └── ...
+│   ├── assets              # module assets (processed by webpack)
+│   │   └── svg             # 存放 svg 图标源文件
+│   │       └── ...
+│   ├── components          # 组件
+│   │   ├── base.ts         # 组件基类，所有组件继承自它
+│   │   ├── icons           # 生产的 svg 图标
+│   │   ├── pages           # 页面级组件
+│   │   ├── tags            # 全局组件 (自定义标签)
+│   │   └── views           # 视图级组件
+│   ├── env                 # 坏境配置
+│   ├── main.ts             # 入口文件
+│   ├── router              # 路由
+│   ├── store               # vuex store
+│   │   ├── modules         # vuex 模块
+│   │   └── utils           # vuex 辅助
+│   └── style               # 样式
+├── static                  # pure static assets (directly copied)
+├── tools                   # 工具，比如用来创建组件
+└── typings                 # 类型定义文件
+│   ├── globals.d.ts        # 全局类型定义
+│   └── interface           # 接口定义
+├── tsconfig.json           # typescript 配置
+├── tslint.json             # typescript 格式检查
+├── .editorconfig           # 编辑器格式配置
+├── .npmrc                  # npm 配置
+├── .postcssrc.js           # postcss 配置
+├── .stylelintrc.js         # 样式检查
+```

docs/README.md

@@ -1,2 +1,13 @@
-# hello
-hello gitbook
+# 简介
+vue-typescript 是在 [vuejs-templates/webpack](https://github.com/vuejs-templates/webpack) 的基础上修改的，主要是将开发语言从 ES6 改成 Typescript。使用本模板之前，建议看一下 [vuejs-templates/webpack 的文档](http://vuejs-templates.github.io/webpack/)
+
+## 开始
+使用该模板，请先安装 [vue-cli](https://github.com/vuejs/vue-cli)
+
+```bash
+npm install vue-cli -g
+vue init MMF-FE/vue-typescript my-project
+cd my-project
+npm install
+npm run dev
+```

docs/SUMMARY.md

@@ -1,4 +1,6 @@
 # Summary
 
-* [Introduction](README.md)
+* [简介](README.md)
+* [项目结构](Project Structure.md)
+* [构建命令](Build Command.md)
 

docs/hello.md

@@ -5,9 +5,9 @@
   "main": "index.js",
   "scripts": {
     "dev": "ENV=dev node build/dev-server.js",
-    "dev-build": "ENV=dev node build/build.js",
-    "sit": "ENV=sit node build/build.js",
-    "deploy": "ENV=deploy node build/build.js",
+    "build:dev": "ENV=dev node build/build.js",
+    "build:sit": "ENV=sit node build/build.js",
+    "build:deploy": "ENV=deploy node build/build.js",
     "svg": "vsvg -s ./src/assets/svg -t ./src/components/icons",
     "cli": "node ./tools/cli.js"
   },