instant-helios v1.3.20

Instant Helios

This package is able to automatically generate a static website, using HTML5Up's Helios design and an extended JsonResume schema.

Preview

Command Line Usage

Install using npm:

npm install -g instant-helios

Use the helios command to generate the website:

helios myDataFile.json

The results will be stored in a /build folder on the directory of the provided data file.
You can use flags to only generate a type of file, instead of the whole website. For example, this will only generate the javascript files:

helios myDataFile.json --js

Full tag list:

--all               Generate everything (default behaviour)
--html or --pug     Generate .html files and resized media files
--css or --sass     Generate .css files
--js                Generate .js files
--assets            Copy static media assets (placeholder images, icons,...)

Programmatic Usage

You can use Instant Helios in node as well:

let helios = require('instant-helios')
let buildDirectory = <a directory of your choosing>
let data = <data structure as if parsed from a .json file>

// Ensure require build directories exist or are created
helios.dirs(buildDirectory)

// Generate .html files and resized media files
helios.html(buildDirectory, data)

// Generate .css files
helios.css(buildDirectory, data)

// Generate .js files
helios.js(buildDirectory)

// Copy media assets
helios.assets(buildDirectory)

// Do all of the above, in order
helios.all(buildDirectory, data)