summaryrefslogtreecommitdiff
path: root/README.md
blob: 79a57d6b6abb8c27126648567c37f6191c3c1e89 (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
26
27
# Grimoire.ca Blog/Wiki

This repository contains the infrastructure for publishing a website, built from a suite of Markdown files and other resources, to a web server.

## Pre-requisites

You will need:

* [Hugo](https://gohugo.io/) (`sudo port install hugo`).

## Building

To prepare this site for deployment, run `hugo` from the project's root directory, using the included `tools/build` script.

The resulting files will be placed in `public` under the project's root directory, replacing any files already present.

You can also preview the site locally:

```bash
hugo serve
```

This will automatically rebuild the site every time the files in `content` change, and will serve them on a web server at <http://127.0.0.1:1313>.

## Publishing

Once the site is built, it can be published using `tools/publish`.