Skip to content

Commit

Permalink
Merge pull request #24561 from storybookjs/docs_remove_transclude_option
Browse files Browse the repository at this point in the history
Docs: Remove `transcludeMarkdown` from addon-docs readme
  • Loading branch information
JReinhold authored Oct 26, 2023
2 parents ece2d24 + 9a2a515 commit 65ea5c5
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions code/addons/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@ export default {
jsxOptions: {},
csfPluginOptions: null,
mdxPluginOptions: {},
transcludeMarkdown: true,
},
},
],
Expand All @@ -157,16 +156,9 @@ export default {

`csfPluginOptions` is an object for configuring `@storybook/csf-plugin`. When set to `null` it tells docs not to run the `csf-plugin` at all, which can be used as an optimization, or if you're already using `csf-plugin` 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';
import Changelog from '../CHANGELOG.md';
> With the release of version 7.0, it is no longer possible to import `.md` files directly into Storybook using the `transcludeMarkdown` [option](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#importing-plain-markdown-files-with-transcludemarkdown-has-changed). Instead, we recommend using the [`Markdown`](https://storybook.js.org/docs/react/api/doc-block-markdown) Doc Block for importing Markdown files into your Storybook documentation.
<Meta title="Changelog" />

<Changelog />
```

## TypeScript configuration

Expand Down

0 comments on commit 65ea5c5

Please sign in to comment.