@alfheim/generator-nef-readme v0.3.2
@alfheim/generator-nef-readme
This package is part of the battery used to create new components for the Nasdaq Experience Framework. This package creates an README.md file, which provides documentation for the component.
Note: It is recommended that you install and use
generator-nef-componentrather than installing this package directly, unless you need to modify the individual file generators.
A README file created for a component named Test using this generator looks as follows:
⚠️ ⚠️ ⚠️ BEGIN README HERE ⚠️ ⚠️ ⚠️
Test
Introduction
Test is an easy-to-use component.
Usage
import { Test } from "@nef/core";Example use
See Story tab on the right.
Properties
| propName | propType | defaultValue | isRequired | Description |
|---|---|---|---|---|
className | string | - | - | is the class name of the component |
children | oneOfType( node, arrayOf( node ) ) | - | - | is the children to be passed into component |
style | object | - | - | is the style object to be passed into component |
name | string | - | - | id to be passed to the DOM |
id | string | - | - | name to be passed to the DOM |
⚠️ ⚠️ ⚠️ END README HERE ⚠️ ⚠️ ⚠️
Getting started
To install, simply run:
yarn add @alfheim/generator-nef-readme --devor
npm install @alfheim/generator-nef-readme --dev Contributing
We'd love to have your helping hand on alfheim! Go over to our issues section and see if there's anything we're looking for help with OR open up a PR if you have an idea for a way to improve the library.
License
Alfheim is open source software licensed as MIT.