Installations

npm install @storybook/mdx1-csf

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.19.1

NPM Version

8.19.3 Score

92.9

Supply Chain

96.6

Quality

81.8

Maintenance

50

Vulnerability

98.9

License

Pull Requests

Open

1

Total

35

Closed

7

Merged

27

Issues

Open

7

Total

12

Closed

5

Releases

26

v1.1.0

Published on 09 May 2023

v1.1.0-next.1

Published on 28 Apr 2023

v1.1.0-next.0

Published on 26 Apr 2023

v1.0.0

Published on 03 Apr 2023

v1.0.0-next.8

Published on 03 Apr 2023

v1.0.0-next.7

Published on 31 Mar 2023

View all 26 releases

Contributors

104

Unable to fetch Contributors

View all 104 contributors

Languages

4

TypeScript

JavaScript

CSS

Shell

TypeScript (93.51%)

JavaScript (3.49%)

CSS (2.92%)

Shell (0.08%)

Developer

storybookjs

Download Statistics

Total Downloads

252,509,123

Last Day

160,237

Last Week

672,187

Last Month

3,138,344

Last Year

54,726,297

GitHub Statistics

15 Stars

98 Commits

9 Forks

7 Watching

9 Branches

104 Contributors

Bundle Size

2.58 MB

Minified

663.39 kB

Minified + Gzipped

Bundlephobia

Maintainers

30

Package Meta Information

Latest Version

1.0.0

Package Id

@storybook/mdx1-csf@1.0.0

Unpacked Size

4.81 MB

Size

828.92 kB

File Count

8

NPM Version

8.19.3

Node Version

16.19.1

Publised On

03 Apr 2023

Total Downloads

Cumulative downloads

Total Downloads

252,509,123

Last day

-6%

160,237

Compared to previous day

Last week

-17.3%

672,187

Compared to previous week

Last month

0.8%

3,138,344

Compared to previous month

Last year

-55.6%

54,726,297

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

@mdx-js/mdx @mdx-js/react

Dev Dependencies

40

Versions

@storybook/mdx1-csf

Storybook's mdx1-csf is a compiler that turns MDXv1 input into CSF output.

For example, the following input:

1import { Meta, Story } from '@storybook/addon-docs';
2
3<Meta title="atoms/Button" />
4
5<Story name="Bar">
6  <Button>hello</Button>
7</Story>

Might be transformed into the following CSF (over-simplified):

1export default {
2  title: 'atoms/Button',
3};
4
5export const Bar = () => <Button>hello</Button>;

API

This library exports three functions to compile MDX: compile, compileSync, and createCompiler.

compile

Asynchronously compile a string:

1import { compile } from '@storybook/mdx1-csf';
2
3const code = '# hello\n\nworld';
4const output = await compile(code);

compileSync

Synchronously compile a string:

1import { compileSync } from '@storybook/mdx1-csf';
2
3const code = '# hello\n\nworld';
4const output = compileSync(code);

createCompiler

Create a compiler plugin for for MDXv1:

1import mdx from '@mdx-js/mdx';
2import { createCompiler } from '@storybook/mdx1-csf';
3
4const code = '# hello\n\nworld';
5mdx.sync(code, { compilers: [createCompiler()] });

Loader

In addition, this library supports a simple Webpack loader that mirrors MDXv1's loader, but adds Webpack5 support.

1module.exports = {
2  module: {
3    rules: [
4      {
5        test: /\.(stories|story)\.mdx$/,
6        use: [
7          {
8            loader: require.resolve('@storybook/mdx1-csf/loader'),
9            options: {},
10          },
11        ],
12      },
13    ],
14  },
15};

Contributing

We welcome contributions to Storybook!

📥 Pull requests and 🌟 Stars are always welcome.
Read our contributing guide to get started, or find us on Discord, we will take the time to guide you

License

MIT

No vulnerabilities found.

No security vulnerabilities found.

Other packages similar to @storybook/mdx1-csf

@storybook/mdx1-csf

Installations

Developer Guide

Yes

CommonJS

16.19.1

8.19.3

Score

Pull Requests

1

35

7

27

Issues

7

12

5

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

storybookjs

Download Statistics

GitHub Statistics

Bundle Size

2.58 MB

663.39 kB

Maintainers

Package Meta Information

Total Downloads

252,509,123

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@storybook/mdx1-csf

API

compile

compileSync

createCompiler

Loader

Contributing

License