11 Home
Fang Li edited this page 2023-11-05 10:05:38 +00:00
This file contains ambiguous Unicode characters

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.

Storybook Histoire
轻量级 / 开发者友好
支持打包方式 Vite、Webpack Vite
可展示并复制源码 自动源代码只支持vue3
支持移动端
智能化程度
emit展示
slot展示
props展示

相对于StorybookhistoireVue-styleguidist的优势:

histoire:

  1. 热更新更快、速度更快、轻量
  2. 在界面上可以直接展示可复制 source 源码(自动源代码只支持vue3)
  3. 支持移动端。调整预览大小以在不同的屏幕尺寸上测试设计
  4. 可以自定义外观来匹配团队风格
  5. 开箱即用的TypeScript、JSX、Styles…
  6. 支持 Nuxt3
  7. 支持 global setup 和 local setup
  8. 支持嵌入 Markdown 文档。使用(可扩展的)Markdown(带有代码片段和语法高亮显示)将文档添加到stories中
  9. Variant grids。在一个网格页面上显示组件的多个变体为了可以一次浏览所有可能的组件的状态
  10. 支持黑色主题。支持可选的story background

Vue-styleguidist:

  1. 通过创建网站来展示和开发组件

  2. 只适用于 Webpack 打包的项目

  3. 在开发上Vue Styleguidist 并不能直接生成预览样式,这个需要手写样式代码。有两种编写组件样例的方式:

      1)README方式 
          在组件的同个目录下新建一个文件 README.md然后直接调用组件代码
    
      2)组件方式: 
          在组件下方增加一个组件 <docs></docs>,并在里面直接使用 Markdown 编写样例。这种容易造成组件代码冗长
    
  4. 忽略props。默认情况下组件中的所有属性props被认为是公开发的。在极少数情况下想要只在文档中的移除部分属性说明。为此可以使用JSDoc的@ignore标签注释在属性前面用于标记在文 档中移除它

  5. 支持 mixins 和 extends。如果导入了minxin或extends也将会被styledist自动添加到你的组件文档中

  6. 可以使用JSDoc中@public标签让方法视为公开并展示在文档中

  7. 在编写组件、属性或方法文档时可以使用以下JSDoc标签

    1@deprecated
    2@seelink
    3@author
    4@since
    5@version