carolineartz / nucleus Goto Github PK

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.

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 .

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.

Nucleus is open-sourced software licensed under the MIT license.