{"bugs":{"url":"https://github.com/storybookjs/csf-mdx2/issues"},"dist":{"shasum":"aa66c871e94a7ddf5b488f038b12db680e2e5a78","tarball":"https://registry.npmjs.org/@storybook/mdx2-csf/-/mdx2-csf-1.0.0-next.2.tgz","fileCount":9,"integrity":"sha512-Mg6pYKhuuMrzF/DcCI5dEA36jx7156bBnCk9uFInthFrr1sLYlj+HfRMibFa/VdJx8L0Wsf/15cIu3xPWriinA==","signatures":[{"sig":"MEUCIQC3Lbu5SWtjw64VlE68LRm5AOec+rUmJi6HI6LkQZrsWQIgV7ZVMunx/ILm08wdDBdIN+NrxpUnNpdbRHM8wlJPthE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26785384,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjmeFeACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrc1Q/8Dn3xV9jHUykuUNgGnzMlunXV3laraBaCSwBqoMw50miEulnY\r\n0UFVqErLvsWUCPXbLJknZjT8yBwiEkUd3ZswWlFS0CDEezAv7IhEEPgCp+eq\r\n+NQLeouQ5RqEn3aNfq2V0rwUyheVSxBBro3XnEpUoODw2qNgQ2cS0JpI1oZN\r\nrAP2kAQ93iW1tTJwdWdDiPn1qiLe2qhuQBIVPwqBX3J6bYfWdZJ+rT+YU0Z7\r\nxi7uHr41zSpwlaLhQB6k0kCcGYrGnYGHpcZpmUQA6CR2lPY0OHeRP+e1KusG\r\n/hPPh1QQ5MzAjgq0knMFb7nWsWTyfQGQQIj1C3AueC02PugKuyiH6oe7P4Kr\r\n/6ASesn+JanRW4E6BjWstbJWuODU8XHqVM+TvuBB1V7B5KL30gTLqTzmrai4\r\nA5VeB50uccgWvx0qJRkkBVsImmd7XlaE70H7FMATyW0QgZfn9f9FeMmgHRuH\r\nsBW5jByW4uDEMAgssn4DnR2bexC9Vm0TtsQi5J4A+MkTjg83OefHyXHtky5H\r\n/IvsaNF0w0FjISTaVNG8c4XiodxeLLc4xQkQNx0n0lYxHrXVkIpfHkxvOkZ3\r\nn/HSZaEXa3QabS2pWDvsfVcZWjmT/vItPecmcCPf+e6Zt02vXNdiYApo0E3G\r\nAv4iOt5HKK4ELbky5D3BG8qTIURIhrMSFkA=\r\n=ftgB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/mdx2-csf","types":"dist/index.d.ts","author":{"name":"Michael Shilman","email":"michael@lab80.co"},"module":"dist/index.mjs","readme":"## @storybook/mdx2-csf\n\nStorybook's `mdx2-csf` is a compiler that turns MDXv2 input into CSF output.\n\nFor example, the following input:\n\n```mdx\nimport { Meta, Story } from '@storybook/addon-docs';\n\n<Meta title=\"atoms/Button\" />\n\n<Story name=\"Bar\">\n  <Button>hello</Button>\n</Story>\n```\n\nMight be transformed into the following CSF (over-simplified):\n\n```js\nexport default {\n  title: 'atoms/Button',\n};\n\nexport const Bar = () => <Button>hello</Button>;\n```\n\n## API\n\nThis library exports an async function to compile MDX, `compile`.\nIt does not support a synchronous compiler because it uses asynchronous\nimports to bridge the ESM/CJS gap. The underlying MDXv2 libraries only\nsupport pure ESM, but this library is used in CJS environments.\n\n### compile\n\nAsynchronously compile a string:\n\n```js\nimport { compile } from '@storybook/mdx2-csf';\n\nconst code = '# hello\\n\\nworld';\nconst output = await compile(code);\n```\n\n## Loader\n\nIn addition, this library supports a simple Webpack loader that mirrors MDXv1's loader, but adds Webpack5 support. It doesn't use MDXv2's loader because it is prohibitively complex, and we want this to be interchangeable with the `@storybook/mdx1-csf`'s loader which is also based on the MDXv1 loader.\n\nThe loader takes two options:\n\n- `skipCsf` don't generate CSF stories for the MDX file\n- `mdxCompileOptions` full options for the [MDX compile function](https://mdxjs.com/packages/mdx/#api)\n\nFor example, to add [GFM support](https://mdxjs.com/guides/gfm/):\n\n```js\nimport remarkGfm from 'remark-gfm';\n\nmodule.exports = {\n  module: {\n    rules: [\n      {\n        test: /\\.(stories|story)\\.mdx$/,\n        use: [\n          {\n            loader: require.resolve('@storybook/mdx2-csf/loader'),\n            options: {\n              skipCsf: false,\n              mdxCompileOptions: {\n                remarkPlugins: [remarkGfm],\n              },\n            },\n          },\n        ],\n      },\n    ],\n  },\n};\n```\n\n## Contributing\n\nWe welcome contributions to Storybook!\n\n- 📥 Pull requests and 🌟 Stars are always welcome.\n- Read our [contributing guide](CONTRIBUTING.md) to get started,\n  or find us on [Discord](https://discord.gg/storybook), we will take the time to guide you\n\n## License\n\n[MIT](https://github.com/storybookjs/csf-mdx2/blob/main/LICENSE)\n","gitHead":"32d5c6e710ea5e4ce927f3528828cdc0a7653ce3","license":"MIT","scripts":{"test":"jest","build":"tsup","start":"yarn build && yarn storybook -- --no-manager-cache --quiet\"","prepare":"husky install","release":"yarn build && auto shipit","prettier":"prettier","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybookjs/csf-mdx2#readme","repository":{"url":"git+https://github.com/storybookjs/csf-mdx2.git","type":"git"},"_npmVersion":"6.14.17","description":"MDXv2 to CSF webpack compiler and loader","directories":{},"lint-staged":{"*.{ts,js,css,md}":"prettier --write"},"maintainers":[{"name":"kylegach","email":"kyle.gach@gmail.com"},{"name":"tooppaaa","email":"clementdungler@gmail.com"},{"name":"ndelangen","email":"ndelangen@me.com"},{"name":"shilman","email":"michael@lab80.co"},{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"hypnosphi","email":"talpa@yandex.ru"},{"name":"danielduan","email":"dduan@yahoo.com"},{"name":"igor-dv","email":"davydkin.igor@gmail.com"},{"name":"pksunkara","email":"pavan.sss1991@gmail.com"},{"name":"tmeasday","email":"tom@thesnail.org"},{"name":"gongreg","email":"gytis.vinclovas@gmail.com"},{"name":"domyen","email":"dom@hichroma.com"},{"name":"usulpro","email":"regx@usul.su"},{"name":"kylesuss","email":"susskyle@gmail.com"},{"name":"ghengeveld","email":"info@ghengeveld.nl"},{"name":"pago","email":"patrick.gotthardt@trivago.com"},{"name":"dandean","email":"me@dandean.com"},{"name":"codebyalex","email":"wilsonc.alexander@gmail.com"},{"name":"mrmckeb","email":"mrmckeb.npm@outlook.com"},{"name":"dannyhw","email":"danny.h.williams@hotmail.com"},{"name":"winkervsbecks","email":"varunvachhar@gmail.com"},{"name":"rvasikarla","email":"vasikarla.raj@gmail.com"},{"name":"amalik2","email":"ahnmalik2@gmail.com"},{"name":"lshadler","email":"lshadler13@gmail.com"},{"name":"phated","email":"blaine.bublitz@gmail.com"},{"name":"yannbf","email":"yannbf@gmail.com"},{"name":"dylanpiercey","email":"pierceydylan@gmail.com"},{"name":"monkeyworks","email":"igor.szyporyn@gmail.com"},{"name":"darleendenno","email":"darleendenno@gmail.com"}],"_nodeVersion":"14.21.1","dependencies":{},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"auto":"^10.3.0","jest":"^27.0.6","tsup":"^6.2.2","husky":">=6","react":"^17.0.1","lodash":"^4.17.21","rimraf":"^3.0.2","prompts":"^2.4.2","ts-jest":"^27.0.4","prettier":"^2.3.1","react-dom":"^17.0.1","storybook":"next","ts-dedent":"^2.2.0","@babel/cli":"^7.12.1","babel-jest":"^27.0.6","remark-gfm":"^3.0.1","typescript":"^4.2.4","@babel/core":"^7.12.3","@jest/types":"^27.0.6","@mdx-js/mdx":"^2.0.0","@types/jest":"^27.0.3","@types/node":"^16.4.1","lint-staged":">=10","@babel/types":"^7.14.8","babel-loader":"^8.1.0","concurrently":"^7.0.0","@babel/parser":"^7.12.11","@types/lodash":"^4.14.167","@babel/template":"^7.14.5","@babel/traverse":"^7.12.11","estree-to-babel":"^4.9.0","@babel/generator":"^7.12.11","@storybook/react":"next","js-string-escape":"^1.0.1","@babel/preset-env":"^7.12.1","@babel/preset-react":"^7.12.5","hast-util-to-estree":"^2.0.2","@testing-library/dom":"^8.1.0","@storybook/addon-links":"next","@testing-library/react":"^12.0.0","jest-environment-jsdom":"^27.0.6","@types/js-string-escape":"^1.0.1","@babel/preset-typescript":"^7.13.0","@storybook/addon-actions":"next","@storybook/react-webpack5":"next","@storybook/testing-library":"next","@storybook/addon-essentials":"next","@testing-library/user-event":"^13.2.1","@storybook/addon-interactions":"next"},"_npmOperationalInternal":{"tmp":"tmp/mdx2-csf_1.0.0-next.2_1671029086617_0.8887292630390946","host":"s3://npm-registry-packages"},"_id":"@storybook/mdx2-csf@1.0.0-next.2","version":"1.0.0-next.2"}