JSDoc tags not parsed | Storybook | Page 1

JSDoc is a fairly standard way of annotating documentation. (https://jsdoc.app/) Some of the tags are already parsed by Storybook (e.g. @default), but most of the tags are ignore. They are not even included on the story page as plain text, simply excluded.

  /**
   * XYZ
   * 
   * @example
   * // three equal columns
   * <Grid columns={3} />
   * // first column is 80px, second one takes up all remaining space
   * <Grid columns="80 1fr" />
   *
   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
   */
  columns?: string | number;

I'll attach an image how it looks like in VS Code and in Stoybook.

Since you're parsing @default already, I assume there's a way to extend this. If someone can give me a head start I can try to take a look at this. Or if it's already on your roadmap, please link a GH issue, would love to see progress on this.

Thanks!

Use JSDoc: Index

Official documentation for JSDoc 3.

#JSDoc tags not parsed