- Exciting release!Introducing "safe npm". Learn more →
nucleus-styleguide
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 715
- increased by10.51%
Weekly downloads
Readme
Home Page • Demo • Getting Started • Documentation
Nucleus is a living style guide generator for atomic css based components. It's a Node application parsing the source SCSS files and reading information from DocBlock annotations.
Quick start
A more detailed installation instruction can be found here.
Install globally (prefered):
npm install -g nucleus-styleguide
Inside your project root folder, create a configuration with:
nucleus init
Run nucleus:
nucleus
Open http://YOUR_LOCAL_DEV_URL/styleguide .
Contributing
If you found a bug, please try to submit a pull request with a failing test. For new issues, please take note of the Contribution guidelines. Especially bug reports should at least contain required information.
Nucleus was developed by pirates from HolidayPirates and PirateTechnologies.
License
Nucleus is open-sourced software licensed under the MIT license.
FAQs
Generate an atomic style guide from DocBlock annotations
The npm package nucleus-styleguide receives a total of 588 weekly downloads. As such, nucleus-styleguide popularity was classified as not popular.
We found that nucleus-styleguide demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.