From 7819b5b4e90ef5b2823d78fcfa32389201d4fbfa Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Tue, 28 Apr 2020 14:19:22 +0800 Subject: [PATCH] MDX syntax documentation --- docs/src/pages/formats/mdx-syntax/index.md | 196 ++++++++++++++++++++- 1 file changed, 195 insertions(+), 1 deletion(-) diff --git a/docs/src/pages/formats/mdx-syntax/index.md b/docs/src/pages/formats/mdx-syntax/index.md index 31e831067b8..bd3b2b60d4b 100644 --- a/docs/src/pages/formats/mdx-syntax/index.md +++ b/docs/src/pages/formats/mdx-syntax/index.md @@ -3,4 +3,198 @@ id: 'mdx-syntax' title: 'MDX Syntax' --- -Syntax documentation coming soon. In the meantime, please refer to the [`addon-docs` MDX README](https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/mdx.md) for more information. +`MDX` is the syntax [Storybook Docs](https://github.com/storybookjs/storybook/blob/next/addons/docs/) uses to capture long-form markdown documentation and stories in one file. You can also write pure documentation pages in `MDX` and add them to Storybook alongside your stories. [Read the announcement](https://medium.com/storybookjs/rich-docs-with-storybook-mdx-61bc145ae7bc) to learn more about how and why it came to be. + +- [Basic example](#basic-example) +- [MDX-Flavored CSF](#mdx-flavored-csf) +- [Writing stories](#writing-stories) +- [Embedding stories](#embedding-stories) +- [Decorators and parameters](#decorators-and-parameters) +- [Documentation-only MDX](#documentation-only-mdx) +- [MDX file names](#mdx-file-names) +- [More resources](#more-resources) + +## Basic example + +Let's get started with an example that combines markdown with a single story: + +```md +import { Meta, Story, Preview } from '@storybook/addon-docs/blocks'; +import { Checkbox } from './Checkbox'; + + + +# Checkbox + +With `MDX` we can define a story for `Checkbox` right in the middle of our +markdown documentation. + + + +
+ + + + +
+ +``` + +And here's how that's rendered in Storybook: + +
+ +
+ +As you can see there's a lot going on here. We're writing Markdown, we're writing JSX, and somehow we're also defining Storybook stories that are drop-in compatible with the entire Storybook ecosystem. + +Let's break it down. + +## MDX-Flavored CSF + +[MDX](https://mdxjs.com/) is a standard file format that combines Markdown with JSX. This means you can use Markdown’s terse syntax (such as `# heading`) for your documentation, and freely embed JSX component blocks at any point in the file. + +MDX-flavored [Component Story Format (CSF)](https://medium.com/storybookjs/component-story-format-66f4c32366df) includes a collection of components called **"Doc Blocks"**, that allow Storybook to translate MDX files into storybook stories. MDX-defined stories are identical to regular Storybook stories, so they can be used with Storybook's entire ecosystem of addons and view layers. + +For example, here's the story from `Checkbox` example above, rewritten in CSF: + +```js +import React from 'react'; +import { Checkbox } from './Checkbox'; +export default { title: "MDX/Checkbox" component: Checkbox }; +export const allCheckboxes = () => ( +
+ + + + +); +``` + +There's a one-to-one mapping from the code in `MDX` to `CSF`, which in turn directly corresponds to Storybook's internal `storiesOf` API. As a user, this means your existing Storybook knowledge should translate between the three. And technically, this means that the transformations that happen under the hood are simple and predictable. + +## Writing stories + +Now let's look at a more realistic example to see a few more things we can do: + +```md +import { Meta, Story, Preview } from '@storybook/addon-docs/blocks'; + +import { Badge } from './Badge'; +import { Icon } from './Icon'; + + + +# Badge + +Let's define a story for our `Badge` component: + + + Positive + + +We can drop it in a `Preview` to get a code snippet: + + + + Negative + + + +We can even preview multiple stories in a block. This +gets rendered as a group, but defines individual stories +with unique URLs and isolated snapshot tests. + + + + Warning + + + Neutral + + + Error + + + + + with icon + + + +``` + +And here's how that gets rendered in Storybook: + +
+ +
+ +## Embedding stories + +Suppose you have an existing story and want to embed it into your docs. Here's how to show a story with ID `some--id` (check the browser URL in Storybook v5+ to see a story's ID): + +```md +import { Story } from "@storybook/addon-docs/blocks"; + +# Some header + +And markdown here + + +``` + +You can also use the rest of the MDX features in conjunction with embedding. That includes source, preview, and prop tables. + +## Decorators and parameters + +To add [decorators](https://github.com/storybookjs/storybook/blob/next/docs/src/pages/basics/writing-stories/index.md#decorators) and [parameters](https://github.com/storybookjs/storybook/blob/next/docs/src/pages/basics/writing-stories/index.md#parameters) in MDX: + +```md + + + +... + +``` + +In addition, global decorators work just like before, e.g. adding the following to your `.storybook/preview.js`: + +```js +import { addDecorator, addParameters } from '@storybook/react'; + +addDecorator(...); +addParameters({ ... }); +``` + +## Documentation-only MDX + +Typically, when you use Storybook MDX, you define stories in the MDX documentation is automatically associated with those stories. But what if you want to write Markdown-style documentation and have it show up in your Storybook? + +If you don't define stories in your MDX, you can write MDX documentation and associate it with an existing story, or embed that MDX as its own documentation node in your Storybook's navigation. + +If you don't define a `Meta`, you can write Markdown and associate with an existing story. See ["CSF Stories with MDX Docs"](recipes.md#csf-stories-with-mdx-docs). + +To get a "documentation-only story", in your UI, define a `` as you normally would, but don't define any stories. It will show up in your UI as a documentation node: + +
+ +
+ +## MDX file names + +Unless you use a custom webpack configuration, all of your `MDX` files should have the suffix `*.stories.mdx`. This tells Storybook to apply its special processing to the `` and `` elements in the file. + +Be sure to update your Storybook config file to load `.stories.mdx` stories, as per the [`addon-docs` installation instructions](../README.md#installation). + +## More resources + +For more information: + +- [Component Story Format (CSF)](../component-story-format/) +- [Storybook Docs](https://github.com/storybookjs/storybook/blob/next/addons/docs/)] +- [Rich docs with Storybook MDX](https://medium.com/storybookjs/rich-docs-with-storybook-mdx-61bc145ae7bc)