0.1.4 • Published 6 years ago
magmar v0.1.4
This project is a fork of cory house's pluralsight course on Reusauble React Components
All of the design decisions are explained in the videos in pluralsight
To get started, 1. yarn install 2. yarn run start (this will watch for changes and regenerate the documentation automatically)
Once you've made your changes, build the static site and publish with the following command. 1. npm run deploy
How to create a component name Label
- Create src/components/Label/index.js with the following code
export {default} from './Label';
- Create src/components/Label/Label.js with your react component
- Add comments to the documentations
- Add examples in src/docs/examples/Label/RequiredLabel.js like so
- Notice that to import a component we use
magmar/ComponentName
where magmar is an alias for src/components
- Notice that to import a component we use
Generated library files go into the lib folder -> these are what you publish to npm and what is imported when you include magmar into your project.
The full static site is created and deployed to https://invaluable.bitbucket.io/
0.1.4
6 years ago