Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: add transcludeMarkdown option in addon-docs #12547

Merged
merged 3 commits into from Apr 29, 2021
Merged

Documentation: add transcludeMarkdown option in addon-docs #12547

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11457ac
Add documentation for `transcludeMarkdown` option
dancingshell Sep 22, 2020
24f7d82
remove "Example" text
dancingshell Sep 22, 2020
2b42954
Update README.md
dancingshell Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions addons/docs/README.md
View file
Open in desktop
Expand Up @@ -154,6 +154,7 @@ module.exports = {
configureJSX: true,
babelOptions: {},
sourceLoaderOptions: null,
transcludeMarkdown: true,
},
},
],
Expand All @@ -164,6 +165,16 @@ The `configureJSX` option is useful when you're writing your docs in MDX and you

`sourceLoaderOptions` is an object for configuring `@storybook/source-loader`. When set to `null` it tells docs not to run the `source-loader` at all, which can be used as an optimization, or if you're already using `source-loader` in your `main.js`.

The `transcludeMarkdown` option enables mdx files to import `.md` files and render them as a component.
```mdx
import { Meta } from '@storybook/addon-docs/blocks';
import Changelog from '../CHANGELOG.md';

<Meta title="Changelog" />

<Changelog />
```

## Manual configuration

We recommend using the preset, which should work out of the box. If you don't want to use the preset, and prefer to configure "the long way" add the following configuration to `.storybook/main.js` (see comments inline for explanation):
Expand Down