update doc

fardiansyah · May 22, 2018 · a2b6670 · a2b6670
1 parent 177d82a
commit a2b6670
Show file tree

Hide file tree

Showing 33 changed files with 40 additions and 2,554 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,38 @@
-# vue-md
+# Vue Material Admin
 
-> A Vue.js project
+### Introduction
+Vue Material Admin Template is a [Vue](https://vuejs.org/index.html/) Based Material Design Admin Template.
+And use [Vuetifyjs](https://vuetifyjs.com/) as base framework.
+Vuetify is Awesome.
 
-## Build Setup
+### Project Structure
+```bash
+├── build
+├── config (Webpack)
+├── src
+│   ├── api
+│   ├── components
+│   ├── mixins
+│   ├── pages (or views)
+│   ├── router
+│   ├── util
+│   ├── theme
+│   │   ├── default.styl
+│   └── App.vue
+│   └── event.js
+│   └── main.js
+├── dist
+├── release
+├── static (or asset)
+├── mock (or script to build mock data)
+├── node_modules
+├── test
+├── README.md
+├── package.json
+├── index.html
+└── .gitignore
+
+### Build Setup
 
 ``` bash
 # install dependencies
@@ -28,3 +58,10 @@ npm test
 ```
 
 For a detailed explanation on how things work, check out the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
+
+### Reference
+
+* [Vuetifyjs](https://vuetifyjs.com/)
+* [Vue](https://vuejs.org/index.html/)
+* [ECharts](http://echarts.baidu.com/option.html)
+* [Stylus](http://stylus-lang.com/)
diff --git a/document/docs/components.md b/document/docs/components.md
diff --git a/document/docs/images/m.png b/document/docs/images/m.png
diff --git a/document/docs/index.md b/document/docs/index.md
diff --git a/document/docs/not_found.md b/document/docs/not_found.md
diff --git a/document/index.html b/document/index.html
diff --git a/document/mkdocs.yml b/document/mkdocs.yml
diff --git a/document/requirements.txt b/document/requirements.txt
diff --git a/document/site/404.html b/document/site/404.html