feat: add Chinese document;🌟

新增:添加中文文档;
This commit is contained in:
iczer 2020-06-27 21:49:04 +08:00
parent b9cdfdc476
commit 2852125b76
27 changed files with 1453 additions and 52 deletions

View File

@ -3,10 +3,7 @@
一个开箱即用的中后台前端/设计解决方案(主要依赖组件库 [ant-design-vue](https://github.com/vueComponent/ant-design-vue)
[预览地址](https://iczer.gitee.io/vue-antd-admin)
![image](https://gitee.com/iczer/vue-antd-admin/raw/master/src/assets/img/preview.png)
## 重要
该项目目前已升级至 vue-cli3 开发环境,部分依赖组件库版本也已更新至最新版本。
vue-cli2 环境代码已封版 [v0.0.1](https://github.com/iczer/vue-antd-admin/tree/0.0.1),如有需要,[点我查看](https://github.com/iczer/vue-antd-admin/tree/0.0.1)
![image](https://gitee.com/iczer/vue-antd-admin/raw/master/src/assets/img/preview.png)
## 环境
* node -- 运行/编译
* yarn -- 依赖管理
@ -43,7 +40,7 @@ $ yarn install
$ yarn serve
```
## 文档
编写中...
[中文文档](https://iczer.github.io/vue-antd-admin/)
## 说明
该项目由仓主在业余由兴趣驱动完成,仍在不断开发完善中。详见:[开发进度](https://github.com/iczer/vue-antd-admin/projects/1)

53
docs/.vuepress/config.js Normal file
View File

@ -0,0 +1,53 @@
module.exports = {
title: 'Vue Antd Admin',
description: 'Vue Antd Admin',
base: '/vue-antd-admin/',
themeConfig: {
logo: '/logo.png',
repo: 'iczer/vue-antd-admin',
docsDir: 'docs',
editLinks: true,
nav: [
{text: '指南', link: '/'},
{text: '配置', link: '/develop/'},
{text: '主题', link: '/advance/theme'},
],
lastUpdated: 'Last Updated',
sidebar: [
{
title: '开始',
path: '/start/',
collapsable: false,
children: [
'/start/use', '/start/faq'
]
},
{
title: '开发',
path: '/develop/',
collapsable: false,
children: [
'/develop/block', '/develop/layout', '/develop/router', '/develop/page', '/develop/theme', '/develop/service', '/develop/mock'
]
},
{
title: '进阶',
path: '/advance/',
collapsable: false,
children: [
'/advance/i18n', '/advance/chart', '/advance/theme', '/advance/error', '/advance/authority'
]
},
{
title: '其它',
path: '/other/',
collapsable: false,
children: [
'/other/upgrade', '/other/community'
]
}
],
nextLinks: true,
prevLinks: true,
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

17
docs/README.md Normal file
View File

@ -0,0 +1,17 @@
---
title: 首页
home: true
heroImage: /logo.png
heroText: Vue Antd Admin
tagline: 开箱即用的中台前端/设计解决方案
actionText: 快速上手 →
actionLink: /start/
features:
- title: 简洁
details: 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- title: 优雅
details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。
- title: 自然
details: VuePress 为每个页面预渲染生成静态的 HTML同时在页面被加载的时候将作为 SPA 运行。
footer: MIT Licensed | Copyright © 2018-present Evan You
---

5
docs/advance/README.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 进阶
lang: zn-CN
---
# 进阶

View File

@ -0,0 +1,5 @@
---
title: 权限管理
lang: zn-CN
---
# 权限管理

5
docs/advance/chart.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 图表
lang: zn-CN
---
# 图表

5
docs/advance/error.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 错误处理
lang: zn-CN
---
# 错误处理

5
docs/advance/i18n.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 国际化
lang: zn-CN
---
# 国际化

5
docs/advance/theme.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 更换主题
lang: zn-CN
---
# 更换主题

5
docs/develop/README.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 开发
lang: zh_CN
---
# 开发

5
docs/develop/block.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 区块
lang: zh-CN
---
# 区块

5
docs/develop/layout.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 布局
lang: zh-CN
---
# 布局

5
docs/develop/mock.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Mock
lang: zh-CN
---
# Mock

5
docs/develop/page.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 页面
lang: zh-CN
---
# 页面

5
docs/develop/router.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 路由和菜单
lang: zh-CN
---
# 路由和菜单

5
docs/develop/service.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 服务端交互
lang: zh-CN
---
# 服务端交互

5
docs/develop/theme.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 主题定制
lang: zh-CN
---
# 主题定制

5
docs/other/README.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 其它
lang: zh-CN
---
# 其它

5
docs/other/community.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 社区
lang: zh-CN
---
# 社区

5
docs/other/upgrade.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 更新日志
lang: zh-CN
---
# 更新日志

5
docs/start/README.md Normal file
View File

@ -0,0 +1,5 @@
---
title: 开始
lang: zh-CN
---
## 开始

9
docs/start/faq.md Normal file
View File

@ -0,0 +1,9 @@
---
title: 常见问题
lang: zh-CN
---
# 常见问题
### 为什么不是 Ant Design Pro Vue
### 如何使用 Vue Antd Admin
### 如何从服务器请求数据
### 是否支持国际化

9
docs/start/use.md Normal file
View File

@ -0,0 +1,9 @@
---
title: 使用
lang: zh-CN
---
# 使用
## 准备
## 安装
## 目录结构
## 本地开发

View File

@ -8,7 +8,10 @@
"build": "vue-cli-service build",
"lint": "vue-cli-service lint",
"predeploy": "yarn build",
"deploy": "gh-pages -d dist"
"deploy": "gh-pages -d dist -r https://gitee.com/iczer/vue-antd-admin.git",
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs",
"docs:deploy": "vuepress build docs && gh-pages -d docs/.vuepress/dist"
},
"dependencies": {
"@antv/data-set": "^0.11.4",
@ -43,6 +46,7 @@
"style-resources-loader": "^1.3.2",
"vue-cli-plugin-style-resources-loader": "^0.1.4",
"vue-template-compiler": "^2.6.11",
"vuepress": "^1.5.2",
"webpack-theme-color-replacer": "^1.3.12",
"whatwg-fetch": "^3.0.0"
},

View File

@ -23,10 +23,10 @@
</a-list>
</a-tab-pane>
<a-tab-pane tab="消息" key="2">
<div class="tab-pane">暂无消息</div>
<a-list class="tab-pane"></a-list>
</a-tab-pane>
<a-tab-pane tab="待办" key="3">
<div class="tab-pane">暂无消息</div>
<a-list class="tab-pane"></a-list>
</a-tab-pane>
</a-tabs>
</a-spin>

1310
yarn.lock

File diff suppressed because it is too large Load Diff