generator-styleguide

0.5.1 • Public • Published

Styleguide generator NPM version

Yeoman generator that builds a simple Hologram styleguide with bootstrap-sass-official starting files and Gulp all ready to use.

Getting Started

To start a styleguide project, you will have to install Yeoman and Hologram globally.

# install Yeoman 
$ npm install -g yo
 
# Install Hologram 
$ gem install hologram

You might have to install the Hologram gem with sudo, depending on your permissions.

To install generator-styleguide from npm, run:

$ npm install -g generator-styleguide

Finally, initiate the generator:

$ yo styleguide
 
# To create a new component: 
$ yo styleguide:component
 
# To create a new Twig page: 
$ yo styleguide:twig
 
#To create a basic Drupal environment with an external styleguide repo 
$ yo styleguide:drupal

Features

  • Gulp
  • Bootstrap Sass
  • Hologram styleguide
  • CSS Autoprefixer
  • jshint linting
  • Browser-sync built-in server
  • Components sub-generator
  • Twig template files sub-generator
  • Drupal sub-generator

TODO

  • Add a README to the Drupal generated files

Credits

License

MIT

Package Sidebar

Install

npm i generator-styleguide

Weekly Downloads

0

Version

0.5.1

License

MIT

Last publish

Collaborators

  • tonifisler