diff options
| -rw-r--r-- | README.md | 12 | ||||
| -rwxr-xr-x | tools/build | 9 | ||||
| -rwxr-xr-x | tools/publish | 9 |
3 files changed, 20 insertions, 10 deletions
@@ -11,11 +11,7 @@ You will need: ## Building -To prepare this site for deployment, run mkdocs from the project's root directory: - -```bash -mkdocs build -``` +To prepare this site for deployment, run mkdocs from the project's root directory, use the included `tools/build` script. The resulting files will be placed in `site` under the project's root directory, replacing any files already present. @@ -29,8 +25,4 @@ This will automatically rebuild the site every time the files in `docs` change, ## Publishing -Once the site is built, it can be published to s3: - -```bash -aws s3 sync --delete site/ s3://grimoire.ca/ -``` +Once the site is built, it can be published to s3 using `tools/publish`. diff --git a/tools/build b/tools/build new file mode 100755 index 0000000..5e25d51 --- /dev/null +++ b/tools/build @@ -0,0 +1,9 @@ +#!/bin/bash -e + +cd "$(dirname "$0")/.." + +## tools/build +## +## Converts the content in docs/ into a deployable website in site/ + +exec mkdocs build diff --git a/tools/publish b/tools/publish new file mode 100755 index 0000000..ee8aa63 --- /dev/null +++ b/tools/publish @@ -0,0 +1,9 @@ +#!/bin/bash -e + +cd "$(dirname "$0")/.." + +## tools/publish +## +## Publishes site/ to the S3 bucket hosting grimoire.ca + +exec aws s3 sync --delete site/ s3://grimoire.ca/ |