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