| 1 | # easy-website-generator [](https://badge.fury.io/js/easy-website-generator) [](https://travis-ci.org/easy-website-generator/easy-website-generator) [](https://codeclimate.com/github/easy-website-generator/easy-website-generator)
|
| 2 |
|
| 3 | The quick and easy way to develop modern and fast static websites a.k.a Easy-Website-Generator =)
|
| 4 |
|
| 5 | ###### Supports:
|
| 6 | * css styling with [sass](http://sass-lang.com/documentation/file.SASS_REFERENCE.html) and pre build helpers
|
| 7 | * javascript development with [coffee](http://coffeescript.org/)
|
| 8 | * html templating with a hacked [haml-coffee](https://github.com/easy-website-generator/haml-coffee)
|
| 9 | * custom and predefined haml helpers via nodeJs modules
|
| 10 | * site map generation
|
| 11 | * google analytics
|
| 12 | * twitter and opengraph tags
|
| 13 | * ...
|
| 14 |
|
| 15 | ###### Uses:
|
| 16 | * [nodejs](https://nodejs.org/en/)
|
| 17 | * [gulp](https://github.com/gulpjs/gulp)
|
| 18 | * [browser-sync](https://browsersync.io/)
|
| 19 | * [Easy-Website-Generator](https://github.com/easy-website-generator/)
|
| 20 |
|
| 21 |
|
| 22 | ### Installation
|
| 23 | First you need to install [nodeJs](https://nodejs.org/en/download/). Then in your terminal:
|
| 24 |
|
| 25 | ```
|
| 26 |
|
| 27 | npm install -g easy-website-generator coffee-script bower gulp
|
| 28 |
|
| 29 | mkdir my-workspace
|
| 30 |
|
| 31 | cd my-workspace
|
| 32 |
|
| 33 | ewg init --theme all
|
| 34 |
|
| 35 | npm install --cached
|
| 36 |
|
| 37 | ewg serve
|
| 38 |
|
| 39 | ```
|
| 40 |
|
| 41 | _In case you have permission problems prefix the commandos with ``sudo``_
|
| 42 |
|
| 43 | _Available themes at the moment: all, simple_
|
| 44 |
|
| 45 | After running ``ewg serve`` the ewg will compile the html pages and opens a browser. On every source change the browser will reload.
|
| 46 |
|
| 47 | ### Ressources
|
| 48 | > "[Easy-Website-Generator](https://github.com/easy-website-generator/)"
|
| 49 |
|
| 50 | > "[Creative-Workflow](http://www.creative-workflow.berlin/company.html)"
|
| 51 |
|
| 52 | ### Available Tasks
|
| 53 | For a compleete list type: ``ewg tasks`` which is equivalent to ``gulp -T``
|
| 54 |
|
| 55 | ### command line arguments
|
| 56 | ```
|
| 57 | Usage: ewg [command] [options]
|
| 58 |
|
| 59 | Commands:
|
| 60 | init initialises a ewg repo
|
| 61 | serve starts a webserver on ewg repo and watches for changes
|
| 62 | generate generates the dist folder from your ewg repo
|
| 63 | tasks show registered tasks
|
| 64 | * call any gulp task by passing it to ewg, also arguments are passed
|
| 65 |
|
| 66 | Options:
|
| 67 | --help Hilfe anzeigen [boolean]
|
| 68 | --version Version anzeigen [boolean]
|
| 69 | --theme installs a zipped theme from url when running ewg "init"
|
| 70 | [Standard: "simple"]
|
| 71 | --production loads production settings when running ewg "serve" or
|
| 72 | "generate", default: development
|
| 73 | --test load test settings when running ewg "serve" or "generate",
|
| 74 | default: development
|
| 75 |
|
| 76 | ```
|
| 77 |
|
| 78 | ### Themes
|
| 79 |
|
| 80 | ``ewg init --theme simple`` see: https://github.com/easy-websites/ewg-theme-simple
|
| 81 |
|
| 82 | ``ewg init --theme default`` see: https://github.com/easy-websites/ewg-theme-default
|
| 83 |
|
| 84 | Planned themes are here: https://github.com/easy-websites
|
| 85 |
|
| 86 | ### Ressources
|
| 87 | > "[Easy-Website-Generator](https://github.com/easy-website-generator/easy-website-generator)"
|
| 88 |
|
| 89 | > "[Creative-Workflow](http://www.creative-workflow.berlin/company.html)"
|
| 90 |
|
| 91 | > TODO docs via github.io page
|
| 92 |
|
| 93 | ### Changes
|
| 94 | ##### Version 0.0.14
|
| 95 | * support new ewg-gemerator basePath option
|
| 96 |
|
| 97 | ##### Version 0.0.13
|
| 98 | * ewg serve now prints colored child process output
|
| 99 |
|
| 100 | ##### Version 0.0.12
|
| 101 | * move and rename ``./src/workspace.yml`` to ``./ewg-config.yml``
|
| 102 | * lib/ewg/workspace full configured via ewg-config.yml
|
| 103 | * new config values introduces ``paths.src.base: './src'`` and ``paths.dist.base: './dist'``
|