summaryrefslogtreecommitdiff
path: root/README.md
blob: dff9e02a02133809af8c7db88ce30bf82fee30eb (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 Amazon.

## Pre-requisites

You will need:

* [MkDocs](https://mkdocs.org) (`brew install mkdocs`)

## Building

To prepare this site for deployment, run mkdocs from the project's root directory:

```bash
mkdocs build
```

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

You can also preview the site locally:

```bash
mkdocs serve
```

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