https://github.com/jaliborc/instant-helios

Instantly build a website using HTML5Up's Helios theme and an extended jsonresume schema.
https://github.com/jaliborc/instant-helios

html5 javascript jsonresume pug sass

Last synced: about 1 month ago
JSON representation

Instantly build a website using HTML5Up's Helios theme and an extended jsonresume schema.

• Host: GitHub
• URL: https://github.com/jaliborc/instant-helios
• Owner: Jaliborc
• Created: 2018-07-01T02:46:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-04T23:18:16.000Z (6 months ago)
• Last Synced: 2024-10-01T15:04:48.154Z (about 1 month ago)
• Topics: html5, javascript, jsonresume, pug, sass
• Language: SCSS
• Homepage:
• Size: 722 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Instant Helios

[![](https://img.shields.io/npm/v/instant-helios.svg)](https://www.npmjs.com/package/instant-helios) [![](https://travis-ci.org/Jaliborc/instant-helios.svg)](https://travis-ci.org/Jaliborc/instant-helios/) ![](https://david-dm.org/jaliborc/instant-helios.svg) ![](https://img.shields.io/npm/l/instant-helios.svg)

This package is able to automatically generate a static website, using  HTML5Up's [Helios](https://html5up.net/helios) design and an extended [JsonResume](https://jsonresume.org/) schema.

[Preview](http://jaliborc.com/)

## 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 = 

    let data = 


    // 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)