From 0d6f58c54a7af6c8b4e6cd98663eb36ec4e3accc Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Tue, 28 Jan 2020 20:49:17 -0500 Subject: Editorial pass & migration to mkdocs. There's a lot in grimoire.ca that I either no longer stand behind or feel pretty weird about having out there. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9db7289..dff9e02 100644 --- a/README.md +++ b/README.md @@ -1,3 +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. + +## 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 . -- cgit v1.2.3 From 6a7b97b436a5a20c172e6b04bf0caa37d544fde4 Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Tue, 28 Jan 2020 23:34:01 -0500 Subject: Add publish instructions. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index dff9e02..2b5ea2d 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This repository contains the infrastructure for publishing a website, built from 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. ## Building @@ -25,3 +26,11 @@ mkdocs serve ``` This will automatically rebuild the site every time the files in `docs` change, and will serve them on a web server at . + +## Publishing + +Once the site is built, it can be published to s3: + +```bash +aws s3 sync --delete site/ s3://grimoire.ca/ +``` -- cgit v1.2.3