Name: styleguide-nucleus
Owner: PwC Experience Center
Description: 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. This repository is based on the official nucleus from Holiday Pirates: https://github.com/holidaypirates/nucleus
Created: 2016-11-07 07:51:59.0
Updated: 2016-11-07 07:59:22.0
Pushed: 2016-11-07 07:56:41.0
Size: 1203
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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):
install -g nucleus-styleguide
Inside your project root folder, create a configuration with:
eus init
Run nucleus:
eus
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.