helianto 0.1.0-beta1

A minimalist static website generator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

Helianto
========

A minimalist website generator written in [Rust][rust].


Installation
------------

You can install Helianto with [Cargo][cargo] :

    cargo install helianto --git="https://github.com/m-r-r/helianto.git"


Basic usage
-----------

### Creating a new project

One you have installed Helianto, you can create a new project with the `--init`
option:

    helianto --init new-website

Helianto will create a directory and populate it with the default template and 
CSS files.  
An exemple page will also be created.

You can then build your site with the following command:

    cd new-website
    helianto


### Changing the layout

You can change the layout of your website by modifying the `page.html.hbs` file
in the `_layouts` directory. If this file is missing, Helianto will use the
builtin one instead.

All the templates are using the [Handlebar][hbs] syntax.


### Changing the assets

By default, Helianto creates a `css` directory containing the stylesheets used
by the website.

Helianto copies all the files wich are not documents to the output directory.
You can thus edit or remove the existing stylesheets and add new static files.

### Adding content

You can create new pages by adding Markdown files in your website's directory.  
The directory structure created by `helianto --init` already include an example page:

```markdown
# Welcome

Created:  2015-12-30T16:47:45+01:00  
Keywords: helianto, test  

This is an example
```

The metadata block is optional, only the title of the document is required.

For now, Helianto only supports the following metadata :


| Name     | Format                             | Comment                               |
|----------|------------------------------------|---------------------------------------|
| Created  | An RFC 3339 date                   | Used to sort the entries in the index |
| Keywords | A coma separated list of  keywords | Used in the HTML metadata             |
| Language | An ISO 639-1 language code         | Used in the HTML metadata             |



[rust]:  http://rust-lang.org                                       "The Rust programming language"
[cargo]: http://doc.crates.io                                       "Cargo, Rust’s Package Manager"
[hbs]:   https://github.com/sunng87/handlebars-rust#handlebars-rust "Rust templating with Handlebars"