Skip to content

youpenglai/vue-cli-plugin-vuepress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

How to Use

进入项目根目录,打开命令行,执行命令 vue add ypl-vuepress --registry https://registry.npm.taobao.org/

1. 产品文档

产品文档的准备,不是一朝一夕就能完成,而是日积月累,关键节点逐步丰富的。
必须具备的有:部署文档、版本更新文档、技术架构文档

1.1 部署文档

记录项目的部署过程
1. 测试环境部署过程,参数配置,注意事项
2. 预上线环境部署过程,参数配置,注意事项
3. 生产环境部署过程,参数配置,注意事项

1.2 版本发布说明

版本号格式规范文档

1.3 版本更新

版本更新的说明,每次发布正式版本,整理更新内容到这里

版本号:xx.xx.xx.x
上线日期:2020-20-09
更新内容:
    优化:xxxx
    修复:xxxx
    新增:xxxxxx

1.4 技术架构文档

主要的技术栈,使用到的主要技术方案

2. 工具介绍

2.1 doc代码 自动生成代码

vue add vuepress

2.2 代码打包、版本更新 自动生成代码

vue add zip-version

工具演示

About

给工程自动添加文档生成工具和初始模板

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published