Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@storybook/mdx1-csf
Advanced tools
Readme
Storybook's mdx1-csf
is a compiler that turns MDXv1 input into CSF output.
For example, the following input:
import { Meta, Story } from '@storybook/addon-docs';
<Meta title="atoms/Button" />
<Story name="Bar">
<Button>hello</Button>
</Story>
Might be transformed into the following CSF (over-simplified):
export default {
title: 'atoms/Button',
};
export const Bar = () => <Button>hello</Button>;
This library exports three functions to compile MDX: compile
, compileSync
, and createCompiler
.
Asynchronously compile a string:
import { compile } from '@storybook/mdx1-csf';
const code = '# hello\n\nworld';
const output = await compile(code);
Synchronously compile a string:
import { compileSync } from '@storybook/mdx1-csf';
const code = '# hello\n\nworld';
const output = compileSync(code);
Create a compiler plugin for for MDXv1:
import mdx from '@mdx-js/mdx';
import { createCompiler } from '@storybook/mdx1-csf';
const code = '# hello\n\nworld';
mdx.sync(code, { compilers: [createCompiler()] });
In addition, this library supports a simple Webpack loader that mirrors MDXv1's loader, but adds Webpack5 support.
module.exports = {
module: {
rules: [
{
test: /\.(stories|story)\.mdx$/,
use: [
{
loader: require.resolve('@storybook/mdx1-csf/loader'),
options: {},
},
],
},
],
},
};
We welcome contributions to Storybook!
FAQs
MDXv1 to CSF webpack compiler and loader
The npm package @storybook/mdx1-csf receives a total of 1,058,814 weekly downloads. As such, @storybook/mdx1-csf popularity was classified as popular.
We found that @storybook/mdx1-csf demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 30 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.