{"_id":"@alfheim/generator-nef-stories-mdx","_rev":"1-51bb3a4f851b5f350c0cb997cd2f965d","name":"@alfheim/generator-nef-stories-mdx","dist-tags":{"latest":"0.2.0"},"versions":{"0.2.0":{"name":"@alfheim/generator-nef-stories-mdx","version":"0.2.0","description":"Yeoman generator for basic NEF component stories using MDX syntax for Storybook","author":{"name":"Haldun Anil"},"homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-stories-mdx","license":"MIT","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-stories-mdx"},"keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"peerDependencies":{"@storybook/addon-docs":"^5.3.8","@storybook/addon-knobs":"^5.3.4"},"gitHead":"4d88f30615cf80140ac8414b96ee02d947628b41","bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"_id":"@alfheim/generator-nef-stories-mdx@0.2.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"dist":{"integrity":"sha512-i2sol7HbOfPoZ/c8Ec7nhQLNr/CDHrRqU3QX4YGgEzldcxEXWhDtB60HMFDHDYW4Ghbh3IT4pdI4UfEKhpHiYg==","shasum":"2afa46ed05e068ae09dd389411ca359c274f7ce9","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-stories-mdx/-/generator-nef-stories-mdx-0.2.0.tgz","fileCount":5,"unpackedSize":7129,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeVVqgCRA9TVsSAnZWagAA8YEP/A+v/QBZe/rfSt5KG/Pl\nMVy833kFlwvmiePv9/U7vpUoLnd5cgdWowRt3sLxx0hvE0q2tEBunjvmC7RA\nxwdoH8q8NccoMhp8O8eFgp9UgqbElA4MmAjQ80YoOy3SbbAYHyRm08xlW3nW\nXPOMJLyGFodRKhQVHvAwc+LyS5/ZJzzMDpPxRZAPh0E+62wvcU65TSgw3LMA\n5vFRiV9MIC78uycBjXwpzvyuuxcwejkNXts1+yJT0OFNjQmbjOvLxi/50BZT\nMw8YhmNcMhOxP4vpstdWDGFjCQmkwQkDNmnSm3CdX5wpqFvTCPs6SxvNXb6n\n6hUN4cyJrQBGm3uQGpy6tHzzXEHS5ZwM1ls2gQNhhyon+Oc6da5fAbs1qJPE\ns/TRAr3dzxGukUYztvMR9ywU940BkDbE+3h3OQ4DOyYhOjQ9nuqnBl2mc/Vd\nNAsXhiNfzZqQj/npFelLLFpbwQwm1CAs3dddQKgoBU6bWImutDXaHaU2Y918\nbIgsQerKFuhifRtYThf/2Z+dtICAgocHoaYUv6OUsCAAnpLN7HDFKtwVcjGN\nvDZpJViO7GxGgC0/LacPK1BK/oIVVWyE1oBE5TnSrJ5d6zli0e2u589X04kn\nFGuEaOtEN2NmypTcvsFHD+r77XYsE9nIwBuIsAmAO6QZzJa8asY6tuq6so0T\ndgAC\r\n=2TAI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICs2DuVdLRPJF+NJYrrU0hdul/ynB9TDuNy7wzzvSSOJAiEA/y+KhpwuJdQIxmOz1WnHp2jlwSJBrdrLvpdvPMHl9UE="}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-stories-mdx_0.2.0_1582652063511_0.5310983973550707"},"_hasShrinkwrap":false}},"time":{"created":"2020-02-25T17:34:23.312Z","0.2.0":"2020-02-25T17:34:23.633Z","modified":"2022-04-04T12:49:06.044Z"},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"description":"Yeoman generator for basic NEF component stories using MDX syntax for Storybook","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-stories-mdx","keywords":["yeoman-generator"],"repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-stories-mdx"},"author":{"name":"Haldun Anil"},"bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"license":"MIT","readme":"# `@alfheim/generator-nef-stories-mdx`\n\n<p>\n  <a href=\"https://travis-ci.org/Nasdaq/alfheim\">\n    <img alt=\"Travis\" src=\"https://img.shields.io/travis/Nasdaq/alfheim/master.svg\">\n  </a>\n  <a href=\"https://www.npmjs.com/package/@alfheim/generator-nef-stories\">\n    <img alt=\"npm (scoped with tag)\" src=\"https://img.shields.io/npm/v/@alfheim/generator-nef-stories-mdx/latest\">\n  </a>\n  <a href=\"https://github.com/Nasdaq/alfheim/blob/master/LICENSE\">\n    <img alt=\"GitHub license\" src=\"https://img.shields.io/badge/license-MIT-blue.svg\">\n  </a>\n  <a href=\"https://github.com/Nasdaq/alfheim/pulls\">\n    <img alt=\"PRs welcome\" src=\"https://img.shields.io/badge/PRs-welcome-green.svg\" />\n  </a>\n</p>\n\nThis package is part of the battery used to create new components for the Nasdaq Experience Framework. This package creates an `<ComponentName>.stories.mdx` file, which contains component stories to display in Storybook.\n\n**In order to use `MDX` files in your Storybook, you will need to install the `@storybook/addon-docs` addon. For more information on how to get set up, please see [here](https://storybook.js.org/docs/formats/mdx-syntax/).**\n\n> _Note: It is recommended that you install and use [`generator-nef-component`](https://github.com/Nasdaq/alfheim/tree/9-add-readme-file/packages/generator-nef-component) rather than installing this package directly, unless you need to modify the individual file generators._\n\nBy default, a component named `Test` created using this generator looks as follows:\n\n```jsx\nimport { Meta, Story, Preview } from \"@storybook/addon-docs/blocks\";\nimport { withKnobs } from \"@storybook/addon-knobs/react\";\n\nimport Test from \".\";\n\n<Meta title=\"Test\" component={Test} decorators={[withKnobs]} />\n\n# Test\n\n<Preview>\n  <Story name=\"basic use\">\n    <Test />\n  </Story>\n</Preview>\n\n## Introduction\n\n`Test` is a React component.\n\n## Usage\n\n\\`\\`\\`javascript\nimport { Test } from \"@nef/core\";\n\\`\\`\\`\n\n## Properties\n\n| propName    | propType                           | defaultValue | isRequired | Description                                     |\n| ----------- | ---------------------------------- | ------------ | ---------- | ----------------------------------------------- |\n| `className` | string                             | -            | -          | is the class name of the component              |\n| `children`  | oneOfType( node, arrayOf( node ) ) | -            | -          | is the children to be passed into component     |\n| `style`     | object                             | -            | -          | is the style object to be passed into component |\n| `name`      | string                             | -            | -          | id to be passed to the DOM                      |\n| `id`        | string                             | -            | -          | name to be passed to the DOM                    |\n\n```\n\n## Getting started\n\nTo install, simply run:\n\n```\n\nyarn add @alfheim/generator-nef-stories-mdx --dev\n\n```\n\nor\n\n```\n\nnpm install @alfheim/generator-nef-stories-mdx --dev\n\n```\n\n## Contributing\n\nWe'd love to have your helping hand on `alfheim`! Go over to our [issues](https://github.com/Nasdaq/alfheim/issues) section and see if there's anything we're looking for help with OR [open up a PR](https://github.com/Nasdaq/alfheim/pulls) if you have an idea for a way to improve the library.\n\n## License\n\n`Alfheim` is open source software [licensed as MIT](LICENSE).\n","readmeFilename":"README.md"}