aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3e21ea9..a8758d5 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,26 @@ To add or edit navbar menu entries:
# edit navbar menu entries
vim data/menu.yaml
+## Serve Locally
+
+To serve this site locally:
+
+ # serve hugo locally on port 1313
+ hugo serve --minify --disableFastRender
+
+**Notes:**
+* `--minify` generates minified HTML, and
+ [`html/template`][html-template] is aware of `<pre>` and `<code>` so
+ inline code blocks work correctly.
+* `--disableFastRenderer` may be unnecessary, but the fast
+ renderer cache was giving me grief while doing theme development.
+
+## Deploy Site
+
+To deploy to production site:
+
+*TODO*
+
# Theme
The current theme is `hugo-pt2021` and is stored in this repository as
@@ -78,8 +98,9 @@ The current theme is `hugo-pt2021` and is stored in this repository as
The [Bulma][] [SASS][] is:
-1. Stripped of extraneous styles and combined with a small amount of
- `pt2021`-specific styling. See `assets/style.sass`.
+1. Stripped of extraneous styles. See `assetes/style.sass`.
+2. Combined with a small amount of `pt2021`-specific styling. See
+ `assets/style.sass`.
2. Converted from [SASS][] to [CSS][], minified, and fingerprinted
using [Hugo Pipes][hugo-pipes]. See `layouts/partials/head.html`.
3. Written to `public/style.$HASH.css`.
@@ -102,3 +123,7 @@ The [Bulma][] [SASS][] is:
"Syntactically Awesome Style Sheets"
[css]: https://en.wikipedia.org/wiki/CSS
"Cascading Style Sheets"
+[go]: https://golang.org/
+ "Go programming language"
+[html-template]: https://pkg.go.dev/html/template
+ "Go's built-in HTML template renderer"