easy-website-generator

generate modern static web pages with sass, coffee, haml and much more

Usage no npm install needed!

<script type="module">
  import easyWebsiteGenerator from 'https://cdn.skypack.dev/easy-website-generator';
</script>

README

easy-website-generator Build Status npm version Code Climate

The quick and easy way to develop modern and fast static websites a.k.a Easy-Website-Generator =)

Supports:
  • css styling with sass and pre build helpers
  • javascript development with coffee
  • html templating with a hacked haml-coffee
  • custom and predefined haml helpers via nodeJs modules
  • site map generation
  • google analytics
  • twitter and opengraph tags
  • ...
Uses:

Installation

First you need to install nodeJs. Then in your terminal:


npm install -g easy-website-generator coffee-script gulp yarn

mkdir my-workspace

cd my-workspace

ewg init --theme simple

yarn install

ewg serve

In case you have permission problems prefix the commandos with sudo

Available themes at the moment: all, simple, wordpress, bootstrap-standalone. Many are planned github.com/easy-websites - help creating them =)

After running ewg serve the ewg will compile the html pages and opens a browser. On every source change the browser will reload.

Ressources

"Easy-Website-Generator"

"Creative-Workflow"

Available Tasks

For a compleete list type: ewg tasks which is equivalent to gulp -T

command line arguments

Usage: ewg [command] [options]

Commands:
  init      initialises a ewg setup
  serve     starts a webserver on ewg `src` folder and watches for changes
  generate  generates the `dist` folder from your `src` folder by executing the pre defined gulp tasks
  tasks     show registered tasks
  *         you can call any gulp task by passing it to the `ewg` command

Options:
  --help        show help                                              [boolean]
  --version     show version                                           [boolean]
  --theme       installs a zipped theme from url when running `ewg init [--theme=simple]`
  --production  loads production settings from your `ewg-config.yml` when running `ewg serve` or
                "generate", default yml section: development
  --test        load test settings from your `ewg-config.yml` when running `ewg serve` or `ewg generate`,
                default yml section: development

Themes

ewg init --theme simple see: https://github.com/easy-websites/ewg-theme-simple

ewg init --theme all see: https://github.com/easy-websites/ewg-theme-all

ewg init --theme bootstrap-standalone see: https://github.com/easy-websites/ewg-theme-bootstrap-standalone

All themes are located here: https://github.com/easy-websites

Ressources

"Easy-Website-Generator"

"Creative-Workflow"

Changes

Version 1.0.1
  • update ewg-generator dependency
  • introduce basic tests / code metrics
Version 1.0.0
  • i guess it is stable now, i used it in in over 20 projects
Version 0.0.17
  • make coffeelint happy
Version 0.0.16
  • fix installer issues with new ewg-config.yml
Version 0.0.15
  • use new basePath option also for workspace path building
Version 0.0.14
  • support new ewg-generator basePath option
Version 0.0.13
  • ewg serve now prints colored child process output
Version 0.0.12
  • move and rename ./src/workspace.yml to ./ewg-config.yml
  • lib/ewg/workspace full configured via ewg-config.yml
  • new config values introduces paths.src.base: './src' and paths.dist.base: './dist'