diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 7 insertions, 8 deletions
@@ -1,28 +1,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. +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: -* [MkDocs](https://mkdocs.org) (`brew install mkdocs`) -* The AWS CLI (`brew install awscli`), logged in on an account with access to the `grimoire.ca` S3 bucket. +* [Hugo](https://gohugo.io/) (`sudo port install hugo`). ## Building -To prepare this site for deployment, run mkdocs from the project's root directory, use the included `tools/build` script. +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 `site` under the project's root directory, replacing any files already present. +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 -mkdocs serve +hugo 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>. +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 to s3 using `tools/publish`. +Once the site is built, it can be published using `tools/publish`. |