# 帮助中心
# 转换word
word格式
word中需要设置对应的标题, 一级标题、二级标题、三级标题对应的会生成导航菜单,默认一级标题只有一个,默认为对应的标题
命名
会解析word的名字,根据.进行切割,最后一个为word的名字,其余的为类名:
func.role.docx func.report.docs会生成目录结构 func/role.md 和 func/report.md
, 在打开/func/role.html中会显示func下所有文件的菜单导航执行
执行对应的命令 npm run md,执行命令会覆情况help文件夹下的所有内容重新生成
# 转换图片
- 配置见gulp-imagemin (opens new window)
- 使用gulp对图片进行压缩处理,默认路径为
assets/img
, 拷贝到对应的./.vuepress/theme/public/img
中去
# 配置
配置文件
配置文件在
./.vuewpress/config
文件夹中界面头部配置
配置对应的head字段
page配置
page配置配置对应的
pageConfig
字段- pageReg 标识当前的界面的path匹配的正则,匹配到则使用该配置
- name 当前界面bread显示的名字
- component 当前界面显示组件的名字,需要在
./.vuewpress/theme/page
中添加对应的组件,并且注册,保证对应 - banner 是否显示banner图
- content 是有显示md文件的内容
- bread 是否显示面包屑
- sidebar 是否显示导航
排序配置
pageSort
字段 - key为对应的path名字 - value为对应的md生成path名字进行排序