Skip to content

Creating a Static Scaffold

Dave Jeffery edited this page Dec 12, 2017 · 4 revisions

From v0.10, Pingy CLI now includes support for custom scaffolds.

pingy-scaffold.json

In a static pingy scaffold only one file is mandatory, pingy-scaffold.json. The file has the following keys:

  • name (mandatory): A short name
  • description (mandatory): A longer description
  • web (boolean): You can omit this key unless you are creating a Web Scaffold
  • dependencies
  • devDependencies
  • pingyJson
  • files: [{input, output, vars, includes}]

You will need to read more about the scaffold options object here.

Scaffold Command

You can test the scaffold using pingy scaffold <path to your scaffold folder>. Read this wiki doc for more information about passing alias/url/paths to the scaffold command.

Example:

Take a look at the example repo for bootstrap-jumbotron: https://github.com/pingyhq/pingy-scaffold-bootstrap-jumbotron.

You may also scaffold a site from the example repo using pingy scaffold pingyhq/bootstrap-jumbotron.

pingy scaffold pingyhq/bootstrap-jumbotron