描述bug
按照官方svelte组件文档指南编写组件文档，但生成的自动文档页面没有该组件的文档。
重现行为的方法
- 创建一个svelte组件
- 以官方推荐的格式记录它
- 启用自动文档
- 运行storybook并查看为其生成的自动文档。请注意，组件描述不存在。
预期行为
用于记录任何svelte故事的官方推荐的markdown文档也应该提供给自动文档。
截图和/或日志
注解文档在VSCode中正常工作的示例：
自动生成的文档不包含相同的信息：
环境
- OS: Mac OS
- Node.js版本：v20.5.0
- NPM版本：9.8.0
- 浏览器(如果适用):N/A
- 浏览器版本(如果适用):N/A
- 设备(如果适用):N/A
其他上下文
这个问题，以及storybookjs/addon-svelte-csf#122,将大大改善Svelte的故事书文档体验。
2条答案
按热度按时间oxalkeyp1#
@Masstronaut,我已将此问题从storybookjs/addon-svelte-csf转移到了主storybook仓库，因为我认为这与插件无关，而是Storybook渲染器本身缺少的一个功能。
dl5txlt92#
据我所知，这与sveldoc-parser如何提取文档有关。描述应该在@component之前，而不是之后。