diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2023-12-18 19:41:51 -0500 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-01-03 03:05:23 -0500 |
| commit | 5562e320736812d1ad309cfaf73383512a87858d (patch) | |
| tree | d93569bd8831f4ea5b90719a61a9d1b217e76b0f /README.md | |
| parent | 27d5717529bf0e7d5806982f1970603bad998eaf (diff) | |
Migrate to Hugo.
This is a big and somewhat complicated decision, but the crux of it is this:
The _mkdocs_ tool embeds a ton of "I am writing a manual" assumptions about document structure.
These assumptions include that there is a single, sitewide TOC, that a top nav bar is broadly an appropriate way to skip around in the document, and numerous others. They serve that use case well, but that's not really what this site _is_, or how I intend it to be approached. I'm trying for something more blog-esque (and deliberately a bit haphazard).
Hugo is an experiment. This commit migrates most pages to it, but it does drop a few; this is a convenient excuse to forget items I'd prefer not to continue publishing.
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`. |