使用npm安装my-vue-doc到全局。
npm install my-vue-doc -g
my-vue-doc提供了cli工具给my系列库做文档服务。
执行:
mydoc init
然后会在当前工程中创建一个/docs-src目录。
执行:
mydoc dev
然后在/docs-src/pages目录中编辑文档即可。
执行:
mydoc build
会build出docs目录。
该框架留给用户配置有三处:
- 文档目录
- 例子目录
- 全局配置
文档目录在/docs-src/pages中,不同于VuePress那种基于MD,该框架是使用Vue的标签构建文档的,这些文档就创建在该目录中。
创建文档的Vue控件,请参考基础控件 和高级控件。
文档的首页要求是在pages目录下的index.vue页面,该页面框架会做静态化,以提升seo的效率,其他页面不会做静态化处理。
供Demo控件使用的例子vue文件所放目录。该目录的文件会通过框架开发的vue-source_loader将Demo的源码读取出来,供Demo框架展示。
/docs-src/app.js是框架的主配置文件,配置如文档库名称、版本等功能,具体请参考 。
可以在/docs-src/app.js中引入全局样式或者当前库。