https://github.com/holidaypirates/nucleus

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.
https://github.com/holidaypirates/nucleus

Last synced: 4 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/holidaypirates/nucleus
• Owner: holidaypirates
• License: mit
• Created: 2016-08-15T14:12:14.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-10T11:09:41.000Z (about 6 years ago)
• Last Synced: 2024-04-14T06:51:20.058Z (10 months ago)
• Language: JavaScript
• Homepage: https://holidaypirates.github.io/nucleus/
• Size: 1.53 MB
• Stars: 475
• Watchers: 13
• Forks: 43
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Nucleus](https://holidaypirates.github.io/nucleus/images/git-header.png)](https://holidaypirates.github.io/nucleus/demo/index.html)

[Home Page](https://holidaypirates.github.com/nucleus/index.html)   •  

[Demo](https://holidaypirates.github.com/nucleus/demo/index.html)   •  

[Getting Started](https://holidaypirates.github.com/nucleus/getting-started.html)   •  

[Documentation](https://holidaypirates.github.com/nucleus/annotation-reference.html)

[![Build Status](https://travis-ci.org/holidaypirates/nucleus.svg?branch=master)](https://travis-ci.org/holidaypirates/nucleus)

[![npm](https://badge.fury.io/js/nucleus-styleguide.svg)](https://www.npmjs.com/package/nucleus-styleguide)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](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](https://holidaypirates.github.io/nucleus/images/git-teaser.png)

## Quick start

A more detailed installation instruction can be found [here](https://holidaypirates.github.com/nucleus/installation.html).

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](https://github.com/holidaypirates/nucleus/blob/master/CONTRIBUTING.md). Especially bug reports should at least contain [required information](https://github.com/holidaypirates/nucleus/blob/master/CONTRIBUTING.md).

Nucleus was developed by pirates from HolidayPirates and PirateTechnologies.

## License

Nucleus is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).