Addon-docs: Chapter component

Hi, I’d like to have some component like <Chapter/> so I can put it above some section name in my .mdx file so I can see it in the sidebar on the left and navigate on it.

For example:

myComponent.stories.mdx:

imports...

# - myComponent

<Chapter name="Usage"/>
## Usage
...
<Chapter name="Imports"/>
## Imports
...

## Default
<Preview>
<Story name="Default" height="10px">
{...}
</Story>
</Preview>

## Special
<Preview>
<Story name="Special" height="10px">
{...}
</Story>
</Preview>

So in the sidebar:

• Usage
• Imports
• Default
• Special

Now, instead of it, I’m using <Story name="Usage" height="0px"/>

[hudochenkov]

@thuringia I just discovered storybook-docs-toc, while was searching for TOC solution for Storybook. Good starting point. But it doesn’t use Storybook or MDX, so it should be styled manually.

[thuringia]

@shilman Thanks for the quick response 😃

While the second answer sounds much better in terms of developer experience, I’m on board with this not being on the roadmap. Major change doesn’t seem worthwhile for this feature at the moment. Some docs on how to work around this, as in the first one, sound really good though.

Right now, I’m thinking about something like the :toc: helper in AsciiDoc. That one should be fairly easy to do with some MDX extension. Maybe even with a one of the new v6 controls or something.

It’s not really pressing on my end, so please don’t feel pressured. Meanwhile, I will check if MDX has an issue for this, may as well bump them. Then we wouldn’t have to so build this specifically for storybook.