Commit a7373b7c authored by lipengcheng 's avatar lipengcheng

docs: 完善文档

parent c29db1da
...@@ -80,10 +80,10 @@ npm run prettier ...@@ -80,10 +80,10 @@ npm run prettier
2. 将测试完成要发版的分支合并到master分支 2. 将测试完成要发版的分支合并到master分支
3. 通过`standard-version`执行相关命令,自动更新`package.json`中的版本号,更新`changelog`,同时打版到master分支: 3. 通过`standard-version`执行相关命令,自动更新`package.json`中的版本号,更新`changelog`,同时打版到master分支:
第一个版本,需要根据当前package.json中的版本初始化tag及changelog:`yarn release:init`; 第一个版本,需要根据当前package.json中的版本初始化tag及changelog:`yarn release:init`;<br>
更新修订版本号:`yarn release:patch` 更新修订版本号:`yarn release:patch`<br>
更新次版本号:`yarn release:minor` 更新次版本号:`yarn release:minor`<br>
更新主版本号:`yarn release:major` 更新主版本号:`yarn release:major`<br>
4. 推送当前分支上的版本号到远程仓库:`git push origin --tags` 4. 推送当前分支上的版本号到远程仓库:`git push origin --tags`
...@@ -152,8 +152,8 @@ npm run prettier ...@@ -152,8 +152,8 @@ npm run prettier
1. 页面组件(通俗理解为与路由对应的组件,也可称路由组件)统一放在`views`目录下。 1. 页面组件(通俗理解为与路由对应的组件,也可称路由组件)统一放在`views`目录下。
2. 页面组件内的小组件、功能组件统一放在`components`目录下。例如,页面组件`pageA.vue`中拆分出了`pageheader.vue`组件,那么在`components`目录下新建一个**与页面同名的`pageA`目录**`pageA`的相关组件放进去即可。 2. 页面组件内的小组件、功能组件统一放在`components`目录下。例如,页面组件`pageA.vue`中拆分出了`pageheader.vue`组件,那么在`components`目录下新建一个**与页面同名的`pageA`目录**`pageA`的相关组件放进去即可。
3. 注意区分`global`目录与`common`目录的不同: 3. 注意区分`global`目录与`common`目录的不同:
`global`:全局组件,可能需要在多处引入使用 `global`:全局组件,可能需要在多处引入使用<br>
`common`:公共组件,全局生效,但在app.vue中引入即可,无需多次引入使用 `common`:公共组件,全局生效,但在app.vue中引入即可,无需多次引入使用<br>
### vuex配置及使用 ### vuex配置及使用
...@@ -164,13 +164,13 @@ npm run prettier ...@@ -164,13 +164,13 @@ npm run prettier
如果新增路由页面`xxx.vue`,在`src/views`目录下新增`xxx.vue`页面之后,在`src/router`目录下新增对应的路由配置文件`xxx.router.js`并将配置通过`export default`导出,配置方式与原有配置无异。导出后即可,会自动注册路由。 如果新增路由页面`xxx.vue`,在`src/views`目录下新增`xxx.vue`页面之后,在`src/router`目录下新增对应的路由配置文件`xxx.router.js`并将配置通过`export default`导出,配置方式与原有配置无异。导出后即可,会自动注册路由。
### layout布局组件配置及使用 ### layout布局组件配置及使用
需要新增布局时,在`src/components/layout`目录下新增`.vue`文件,类似`App.vue`,其中`<router-view></router-view>`用于渲染路由组件。 需要新增布局时,在`src/components/layout`目录下新增`.vue`文件,类似`App.vue`,其中`<router-view></router-view>`用于渲染路由组件。<br>
文件内的`name`属性为布局名称,需要应用此布局的页面,在对应的路由配置文件`xxx.router.js`中,配置`meta`属性,`meta.layout`赋值为布局名称即可。 文件内的`name`属性为布局名称,需要应用此布局的页面,在对应的路由配置文件`xxx.router.js`中,配置`meta`属性,`meta.layout`赋值为布局名称即可。
### 全局组件配置及使用 ### 全局组件配置及使用
`/src/components/global`目录下添加`.vue`组件,并声明`name`属性即可,会自动引入并挂载到vue实例上。 `/src/components/global`目录下添加`.vue`组件,并声明`name`属性即可,会自动引入并挂载到vue实例上。<br>
注意,`name`属性必填,且`name`的值就是使用时的组件名称。 注意,`name`属性必填,且`name`的值就是使用时的组件名称。<br>
## Customize configuration ## Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/). See [Configuration Reference](https://cli.vuejs.org/config/).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment