Open
Description
Describe the bug
Following the official svelte component documentation guidelines doesn't result in the autodocs generated page having documentation for the component.
Steps to reproduce the behavior
- Create a svelte component
- Document it in the officially recommended format
- enable autodocs
- run storybook and look at the generated autodocs for it. Note that the component description is not present.
Expected behavior
The same markdown documentation used for the officially recommended method of documenting a component should also be provided to the autodocs for any svelte stories.
Screenshots and/or logs
Example of the commented documentation working within VSCode:
Example of the autodoc-generated documentation not containing that same information:
Environment
- OS: Mac OS
- Node.js version: v20.5.0
- NPM version: 9.8.0
- Browser (if applicable): N/A
- Browser version (if applicable): N/A
- Device (if applicable): N/A
Additional context
This issue, along with storybookjs/addon-svelte-csf#122 would go a long way towards improving the storybook docs experience for Svelte.
Metadata
Metadata
Assignees
Type
Projects
Status
No status