diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..16ffaf6 --- /dev/null +++ b/README.md @@ -0,0 +1,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` | |