小鹅通组件

# 小鹅通组件文档系统

为了更好的规范前端使用组件，避免出现重复的组件，也为别人更好的使用组件，所以将组件都录入组件文档系统，方便他人查阅及使用

# 如何部署

本项目使用了gitlab-ci自动部署，不需要build直接提交更改的文件，即可在编译机上自动部署更新

# 如何开始

  • 首先安装node (opens new window)环境，并确保版本大于等于8
  • 然后安装vuepress (opens new window)环境，npm install vuepress -g(window执行)/sudo npm install vuepress -g(MAC执行)
  • 接着安装依赖：npm install
  • 最后运行：npm run dev(window执行)/sudo npm run dev(MAC执行)
  • 更新打包：npm run build(现已不需要执行build命令，提交代码后会在机器上自动编译)

# 系统规范

  • 组件存放位置：.vuepress/components
  • 文件打包位置：.vuepress/dist
  • 公共文件位置：.vuepress/public
    • 如果是截图请放入对应的项目对应的组件文件夹下，如：/h5/toast/1.png
    • 如果是组件中引的图片，可以根据组件中引入位置存放，如：/images/serverBuy/icon_checkbox.png
  • 文档存放位置：docs

# 关于组件

为了能够正常的组件展示组件示例，已经全局引入了网络请求(axios)，并且将地址转向了RAP (opens new window)，所以如果想让网络请求正常，去RAP系统下写个接口mock数据即可 原来的rap仓库已经找不到了，这边新建了一个，之后mock可以用以下账号：

RAP账号: cooperxie@xiaoe-tech.com

RAP密码: xiaoe2022

ps: 只需要在当前仓库的模块下继续写mock接口就好了

# 文档规范

# 文档开头

希望你的文档开头是这个样子，有title, keywords, description, author，这样我们就能知道该文档的一些基础信息，是关于什么的，做什么的，谁写的，下面是示例：

---
title: toast
meta:
    - name: description
      content: 用户操作反馈的提示
    - name: keywords
      content: toast
    - name: author
      content: Chazz
---
1
2
3
4
5
6
7
8
9
10

# 文档主题

主题主要讲组件详细用法，如果能在文档中直接调用，显示出效果最好，如果因为某些原因不能显示，请放上截图，如何编写请参考 toast

# 文档静态文件

如果是组件的截图，请放入public对应的系统对应的组件文件下

# 文档配置

  • 路由配置，顶部导航栏侧边栏配置： .vuepress/config.js
  • 引入其他插件/修改js配置： .vuepress/enchanceApp.js
  • 修改/增加全局css变量: .vuepress/override.styl
  • 修改/增加全局css: .vuepress/style.styl

# 更多配置

请看: vuepress (opens new window)