Skip to content
This repository has been archived by the owner on May 8, 2018. It is now read-only.

Running the Pixel2HTML Generator

Juan Manuel Garcia Olivares edited this page Nov 16, 2017 · 2 revisions

Option 1: Answering the questions

To generate the Pixel2HTML Boilerplate go to your project folder and run this command in your shell

$ cd ~/your/project/folder
$ yo pixel2html

The Pixel2HTML Boilerplate will ask you questions about this points. Answering with the desired options will generate the code.

  • Project Name?
  • Quantity of screens?
  • Markup Language? Options: HTML/Pug
  • Markup Integration? Options: None/Jekyll
  • Frontend Framework Options: None/Bootstrap/Foundation
  • jQuery? Options: true/false

Option 2: Using available parameters

You also can answer this questions passing parameters to the generator command.

Here there are the available questions:

  • --projectName (string)
  • --qtyScreens (int)
  • --markupLanguage (string) [html, pug]
  • --markupIntegration (string) [jekyll, none]
  • --frontEndFramework (string) [bootstrap, foundation, none]
  • --jQuery (bool)

Example:

$ yo pixel2html --projectName=Floyd --markupLanguage='html'

Option 3: Using the config file

You can create a .project.conf file in the root directory of your project. Here an example of it's structure:

{
  "projectName": 'XXX',
  "qtyScreens": 4,
  "markupLanguage": 'html',
  "markupIntegration": 'jekyll',
  "frontEndFramework": "bootstrap",
  "jQuery": true
}

Once you answered all the question, you can hit at:

$ yo pixel2html