Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.15 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.15 KB

@storybook/docs-mdx

Storybook MDX docs is a small library that analyzes the contents of a .docs.mdx file and produces metadata about its contents.

This is an internal library, used to help generate the Storybook's index.json, the static index of all the contents of your storybook.

It currently produces:

name example description
title <Meta title="x"> A manually specified title
of <Meta of={buttonMeta}> A title specified by an imported object
imports import * from './Button.stories' The list of ESM imports

Getting Started

FIXME: Add getting started steps

Contributing

We welcome contributions to Storybook!

  • 📥 Pull requests and 🌟 Stars are always welcome.
  • Read our contributing guide to get started, or find us on Discord, we will take the time to guide you

License

MIT