关于vue组件文档生成备注

前言

在我们团队开发时一定会有一些公共组件诞生出来,那么这些诞生出来的组件我们要怎么让别人知道并且使用呢。写一个专门维护的文档页面?专人去维护?还是选择一个线上公共word的更新上去?
其他的我就不说什么优缺点了 自己体会
我只说一下我们团队中是怎么维护这些公共组件的。
说之前我们先了解一下这个插件vue-styleguidis

npm的说话时:Vue-Styleguidist是Vue组件的样式指南生成器。它列出了组件,并根据Markdown文件显示了可编辑的实时使用示例。您可以使用它来生成静态HTML页面以进行共享和发布,也可以使用该平台作为使用热重载的dev服务器开发新组件的工作台。

看到了吧,说的很清楚 Vue组件的样式指南生成器。它列出了组件,并根据Markdown文件显示了可编辑的实时使用示例
好!下面就是我在实际项目中的应用

内容实现

我们项目是使用vue-cli来创建的,我也只讲这个其他的你们去搜其他的博客吧,
cd到自己的项目下,敲下如下命令。

vue add styleguidist

这时我们项目会增加一下文件和代码如图
在这里插入图片描述
package.json中增加了

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值