Wondering what’s next for npm?Check out our public roadmap! »

create-static

1.0.1 • Public • Published

create-static

Create static html pages with ESNext, SCSS and Nunjucks.

Install

npm i create-static --save-dev

Usage

CLI

Usage: create-static -s ./path/to/src -o ./path/to/dist
 
Options:
  --source, -s   path to source folder containing all promo folders
  --output, -o   path to dist folder with resulted builds
  --help, -h     print help
  --version, -v  print version

Code

const createStatic = require('create-static');
const source = './path/to/src';
const output = './path/to/dist';
 
createStatic.run({ source, output })
  .then(() => {
    console.log('Success!');
  })
  .catch(err => {
    console.log(err);
  });

Source structure

Every folder in source folder should have following structure:

  • index.html - required, html powered by nunjucks template engine
  • content.yml - optional, data to render inside html
  • index.js - optional, javascript powered by browserify and babelify (uses es2015 and stage-0 presets)
  • indes.scss - optional, css powered by node-sass
  • assets - optional folder to store all static files (it will be copied into build)
.
|____dist
|____src
| |____page-1
| | |____index.html # required 
| | |____index.js
| | |____index.scss
| |____page-2
| | |____assets
| | | |____icon.png
| | | |____some-webfont.woff
| | |____index.html # required 
| | |____index.scss
| |____page-3
| | |____content.yml
| | |____index.html # required 
| | |____index.scss
# as many folders as you want... 
create-static -s ./src -o ./dist
# will output all ready to use files in `dist` folder 

MIT Licensed

Install

npm i create-static

DownloadsWeekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • avatar