This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
histoire:
Vue-styleguidist:
通过创建网站来展示和开发组件
只适用于 Webpack 打包的项目
在开发上,Vue Styleguidist 并不能直接生成预览样式,这个需要手写样式代码。有两种编写组件样例的方式:
1)README方式: 在组件的同个目录下,新建一个文件 README.md,然后直接调用组件代码 2)组件方式: 在组件下方增加一个组件 <docs></docs>,并在里面直接使用 Markdown 编写样例。这种容易造成组件代码冗长
忽略props。默认情况下,组件中的所有属性props被认为是公开发的。在极少数情况下,想要只在文档中的移除部分属性说明。为此,可以使用JSDoc的@ignore标签注释在属性前面,用于标记在文 档中移除它
支持 mixins 和 extends。如果导入了minxin或extends,也将会被styledist自动添加到你的组件文档中
可以使用JSDoc中@public标签让方法视为公开,并展示在文档中
在编写组件、属性或方法文档时,可以使用以下JSDoc标签:
1)@deprecated 2)@see,link 3)@author 4)@since 5)@version
Deleting the wiki page "Home" cannot be undone. Continue?