Security News
OpenJS: “XZ Utils Cyberattack Likely Not an Isolated Incident”
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
@storybook/mdx1-csf
Advanced tools
Weekly downloads
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,122,827 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.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.
Security News
OSI is starting a conversation aimed at removing the excuse of the SaaS loophole for companies navigating licensing and the complexities of doing business with open source.