Skip to content

ade25/generator-sitetheme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

generator-sitetheme

Yeoman generator that scaffolds out a front-end theme directory.

Features

  • CSS Autoprefixing
  • Built-in preview server with LiveReload
  • Automagically compile SASS(SCSS)
  • Automagically wire up all components and modules
  • Awesome Image Optimization (via OptiPNG, pngquant, jpegtran and gifsicle)
  • Jekyll template generation
  • Cache busting for production use
  • Integration with plone.app.theming via replacement parts

Getting Started

What is Yeoman?

Yeoman lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

Install Node/npm (the clean way)

If you intent to do frontend development with npm, it is recommended you setup a usable development environment with the help of nvm.

In order to use nvm you need to uninstall/remove any previously installed Node/npm versions. Follow the instructions on npmjs.com or remove all traces of Node and npm by running the commands found here.

Then issue the following command to install nvm:

$ wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.24.0/install.sh | bash

Setup the installed node version manager by sourcing the setup to your shell:

$ source ~/.nvm/nvm.sh

Note: to make this setting persist, add the source line to your ~/.profile or ~/.bash_profile.

Install Node/NPM:

Install the latest stable version of node (which will include the matching release of npm) by running:

$ nvm install node --reinstall-packages-from=node
$ nvm alias default stable

You can also create a file ~/.nvmrc in your home folder containing a version number, e.g.0.12.2 (this should match the desired default node release):

$ cat ~/.nvmrc
0.12.2

After you have installed and setup npm just open a Terminal window and install YEOMAN:

$ npm install -g yo gulp-cli

Done and ready to go!

Generator Setup/Installation

To install generator-diazotheme from npm, clone this repository and link the package to your local npm executable:

$ git clone git@github.com:ade25/generator-diazotheme.git
$ cd ./generator-sitetheme
$ npm link

Finally, initiate the generator:

$ yo sitetheme

License

MIT License

About

A Yeoman generator for Diazo compatible site themes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published