Socket
Socket
Sign inDemoInstall

nucleus-styleguide

Package Overview
Dependencies
160
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    nucleus-styleguide

Generate an atomic style guide from DocBlock annotations


Version published
Weekly downloads
460
increased by20.42%
Maintainers
1
Install size
11.9 MB
Created
Weekly downloads
 

Readme

Source

Nucleus

Home Page   •   Demo   •   Getting Started   •   Documentation

Build Status npm license

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.

Nucleus Preview

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.

Keywords

FAQs

Last updated on 04 May 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc