aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 16ffaf6261ffe80ee9ef1207ec260cf614adbec4 (plain)
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
# panulat
A static site generator for my own website. Uses 
[ejs](https://ejs.co/) for templates.

## Building and running

This program is intended to be run using Docker.

### Using Docker
```
$ docker build -t panulat .
```

The program uses the following environment variables:

| Name                    | Value                                                       | Default  |
|-------------------------|-------------------------------------------------------------|----------|
| `PAGES_DIR`             | The directory containing Markdown and HTML formatted pages. | `pages`  |
| `VIEWS_DIR`             | The directory containing templates.                         | `views`  |
| `STATIC_DIR`            | The directory containing static files to be copied.         | `static` |
| `OUTPUT_DIR`            | The output directory for rendered pages.                    | `build`  |
| `WEBSERVER_ENABLED`     | If the webserver should start. Used for testing.            | `false`  |
| `WEBSERVER_AUTOREBUILD` | If pages should be automatically rebuilt when changing.     | `true`   |
| `WEBSERVER_PORT`        | The port the webserver should listen on.                    | `3000`   |
| `LOGGING_LEVEL`         | How verbose logs should be.                                 | `info`   |