📁 文件夹路径规则:在 help-center 文件夹下的 vuepress-theme-vdoing-doc/docs/ 文件夹下新建文件夹;
✏️ 页面改造规则:第一个测试页面不可删除,这是帮助中心的入口页面,请勿删除(可以改造)!
💡 编写建议:因为编写完成后页面不会实时刷新,需要重新启动服务才能看到效果。建议将编写好的MD格式文件复制到目录下后重新打包构建后刷新页面查看效果。
📋 命名规则:
▪ 文件夹命名规则:01.(侧边栏根据数字生成必须要!!!) 页面名称(无后缀)
▪ 文件命名规则: 01.功能名称.md;
👀️ 静态资源放置规则:
▪ 页面图片和其对应的md文档放置在同一文件夹下。如果是其他公用图片例如公司图标等则放置在public文件夹下
▪ 通过相对路径引用 例如:(./图片.png)
📦 打包部署规则:确认无误后进入 vuepress-theme-vdoing-doc 路径执行 npm run build:win(仅Windows系统需要加win) 打包命令
⚠️ 警告:如果帮助中心不放在当前路径下,请将配置文件中的打包路径改成自定义路径,否则会丢失JS和CSS样式。
配置文件路径:docs/.vuepress/config.js