1 | # Huginn
|
2 | pronounced "HOO-gin"
|
3 |
|
4 | "On, Hekyll! On, Jekyll! On Huginn and Muninn!"
|
5 |
|
6 | Static Page generator
|
7 |
|
8 | ## Quick Start
|
9 |
|
10 | ### Install
|
11 |
|
12 | ```bash
|
13 | $ sudo npm install huginn -g
|
14 | ```
|
15 |
|
16 |
|
17 | ### Create a new application
|
18 |
|
19 | ```bash
|
20 | $ huginn create <appname>
|
21 | $ cd <appname>
|
22 | $ huginn build
|
23 | $ huginn serve
|
24 | ```
|
25 |
|
26 | #### (More...) [http://darkoverlordofdata.com/huginn/]
|
27 |
|
28 | ### Usage
|
29 |
|
30 | Usage:
|
31 | huginn create PATH
|
32 |
|
33 | cd PATH
|
34 | huginn build [--drafts]
|
35 | huginn serve
|
36 |
|
37 | Options:
|
38 | -b [--branch] # branch name subfolder, defaults to master
|
39 | -d [--drafts] # publish _drafts folder
|
40 | -h [--help] # display this message
|
41 | -p [--port] # port to use
|
42 | -v [--version] # display version
|
43 |
|
44 | --dev # use config-dev.yml
|
45 |
|
46 |
|
47 |
|
48 | ## License
|
49 |
|
50 | (The MIT License)
|
51 |
|
52 | Copyright (c) 2012 - 2013 Bruce Davidson <darkoverlordofdata@gmail.com>
|
53 |
|
54 | Permission is hereby granted, free of charge, to any person obtaining
|
55 | a copy of this software and associated documentation files (the
|
56 | 'Software'), to deal in the Software without restriction, including
|
57 | without limitation the rights to use, copy, modify, merge, publish,
|
58 | distribute, sublicense, and/or sell copies of the Software, and to
|
59 | permit persons to whom the Software is furnished to do so, subject to
|
60 | the following conditions:
|
61 |
|
62 | The above copyright notice and this permission notice shall be
|
63 | included in all copies or substantial portions of the Software.
|
64 |
|
65 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
66 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
67 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
68 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
69 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
70 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
71 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|