storybookjs/storybook

[Documentation]: Need instruction on how to get basic extended Markdown functionalities such as table

Open

#24718 opened on Nov 4, 2023

View on GitHub
 (4 comments) (6 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
documentationhelp wanted

Description

Describe the problem

Storybook 7 disabled GFM and asked the user to add it as a plugin by themselves.

Yet, the current documentation for using GFM is insufficient in several ways: https://github.com/storybookjs/storybook/blob/f4455027b3feaeb9975ebc3deff14241177f8c1c/docs/writing-docs/mdx.md?plain=1#L184

  1. It doesn't show possible caveats. For example,
  1. It doesn't show any direct example of setting up common features of GFM, like how can you get your Markdown table to render (cause I still couldn't get the table to render, like several others such as here and here.

I feel it's essential to explain how to use common documentation features such as tables in MDX2 and Storybook 7.

After all, one of the main attractions for using MDX is precisely the markdown documentation features, because we already have stories for rendering components.

Suggestion

  • Provide a working guide and example to show the user how to use GFM features that address the above issues.

I'd really like to help with adding the documentation if only I could get it to work myself. So I think it's perhaps that someone on the maintenance team fixes the GFM features on v7 first.

Additional context

No response

Contributor guide