Rethink directory structure. (#37)

alxmrs · web-flow · commit efb0e1fb8456 · 2025-03-08T19:14:32.000-08:00
* Rethink directory structure.

Only content exists in `src`. Templates, static and assets lives elsewhere.

Images now work in both the IDE and website. It's all intutive.

* fix curl arg.
diff --git a/README.md b/README.md
@@ -16,17 +16,18 @@ gathers all files not named "index.md" into an RSS feed.
  
 This tool is configurable by environment variables.
 
-| Variable  | Description                                         | Default            |
-|-----------|-----------------------------------------------------|--------------------|
-| `SRC`     | Root directory of input sources.                    | `src/`             |
-| `DST`     | Root directory for generated output.                | `public/`          |
-| `STATIC`  | Directory for static assets.                        | `$SRC/static`      |
-| `SRC_EXT` | Input sources file extension.                       | `md`               |
-| `DST_EXT` | Output generation file extension.                   | `html`             |
-| `HEADER`  | path/to/header.html (`--include-before-body`).      | `$SRC/header.html` |
-| `FOOTER`  | path/to/footer.html (`--include-after-body`).       | `$SRC/footer.html` |
-| `CSS`     | path/to/style.css embedded in header of a web page. | `/main.css`        |
-| `PANOPTS` | Arguments to pass to Pandoc for each input file.    | `--css $CSS --metadata-file=$ROOT/defaults.yml -B $HEADER -A $FOOTER` |
+| Variable  | Description                                         | Default                                                                              |
+|-----------|-----------------------------------------------------|--------------------------------------------------------------------------------------|
+| `SRC`     | Root directory of input sources.                    | `src/`                                                                               |
+| `DST`     | Root directory for generated output.                | `public/`                                                                            |
+| `ASSETS`  | Directory to store media, like images               | `assets/`                                                                            |
+| `STATIC`  | Directory for static site assets, like CSS files.   | `$SRC/static/`                                                                       |
+| `SRC_EXT` | Input sources file extension.                       | `md`                                                                                 |
+| `DST_EXT` | Output generation file extension.                   | `html`                                                                               |
+| `HEADER`  | path/to/header.html (`--include-before-body`).      | `template/header.html`                                                               |
+| `FOOTER`  | path/to/footer.html (`--include-after-body`).       | `template/footer.html`                                                               |
+| `CSS`     | path/to/style.css embedded in header of a web page. | `css/main.css`                                                                       |
+| `PANOPTS` | Arguments to pass to Pandoc for each input file.    | `--css $CSS --metadata-file=$ROOT/defaults.yml -B $HEADER -A $FOOTER" -V lang=en-US` |
 
 To make it easier to edit metadata for every page, consider making changes to the `defaults.yml` at the project root.
 
@@ -41,6 +42,8 @@ for more inspiration.
 
 `bin/watch` will watch the source directory. On any changes, it will invoke the build script.
 
+> Note: if you change files outside of `$SRC` (i.e. in `template/` or `static/`), you'll need to terminate and 
+> re-run this script.
 
 ### Deployment
 
diff --git a/assets/birth-aging-dying.webp b/assets/birth-aging-dying.webp
diff --git a/assets/kraftwerk.webp b/assets/kraftwerk.webp
diff --git a/bin/build b/bin/build
@@ -37,26 +37,17 @@ convert() {
   pandoc $PANOPTS "$file" --output="$DST$TO" || warn "Failed to create $TO"
 }
 
-copy() {
-  file="$1"
-  FROM=$file
-  TO="$DST${file##"$STATIC"}"
-  echo "${FROM##"$ROOT"} --> ${TO##"$ROOT"}"
-  mkdir -p "$(dirname "$TO")"
-  cp "$FROM" "$TO" || warn "Failed to copy asset $TO"
-}
-
 status "Rendering"
 find "$SRC" -type f -name "*.$SRC_EXT" | while IFS= read -r file; do
   convert "$file" &
 done
 wait
 
+status "Copying over static"
+cp -r "$STATIC/"* "$DST"
+
 status "Copying over assets"
-find "$STATIC" -type f | while IFS= read -r file; do
-  copy "$file" &
-done
-wait
+cp -r "$ASSETS" "$DST"
 
 status "Rendering RSS feed"
 # This does the following:
@@ -72,7 +63,7 @@ echo "$ORDERED_POSTS"
 # shellcheck disable=SC2086
 pandoc-rss -s \
     -t "My Pandoc Blog" \
-    -d "A blog built with Pandaoc" \
+    -d "A blog built with Pandoc" \
     -l "https://github.com/alxmrs/pandoc-website-template" \
     -f "%s/" \
     -c "MIT or CC BY-SA 4.0" \
diff --git a/bin/env b/bin/env
@@ -1,14 +1,15 @@
-#!/bin/sh
+#!/usr/bin/env sh
 #
 # Environment variables, with defaults.
 #
 ROOT=$(dirname "$(dirname "$(realpath "$0")")")
 SRC=${SRC:-"$ROOT/src"}
 DST=${DST:-"$ROOT/public"}
-STATIC=${STATIC:-"$SRC/static"}
-HEADER=${HEADER:-"$SRC/header.html"}
-FOOTER=${FOOTER:-"$SRC/footer.html"}
+ASSETS=${ASSETS:="$ROOT/assets"}
+STATIC=${STATIC:-"$ROOT/static"}
+HEADER=${HEADER:-"$ROOT/template/header.html"}
+FOOTER=${FOOTER:-"$ROOT/template/footer.html"}
 CSS=${CSS:-"/css/main.css"}
 SRC_EXT=${SRC_EXT:-"md"}
 DST_EXT=${DST_EXT:-"html"}
-PANOPTS=${PANOPTS:-"--css $CSS --metadata-file=$ROOT/defaults.yml -B $HEADER -A $FOOTER"}
+PANOPTS=${PANOPTS:-"--css $CSS --metadata-file=$ROOT/defaults.yml -B $HEADER -A $FOOTER" -V lang=en-US}
diff --git a/bin/install b/bin/install
@@ -1,12 +1,12 @@
-#!/bin/sh
+#!/usr/bin/env sh
 set -e
 #
 # Install pandoc on debian.
 #
-
-curl -O -L -C - https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-1-amd64.deb
-sudo dpkg -i pandoc-2.19.2-1-amd64.deb
-rm pandoc-2.19.2-1-amd64.deb
+VERSION="3.6.3"
+curl -o pandoc.deb -L -C - "https://github.com/jgm/pandoc/releases/download/$VERSION/pandoc-$VERSION-1-amd64.deb"
+sudo dpkg -i pandoc.deb
+rm pandoc.deb
 
 #
 # Install pandoc-rss on debian.
diff --git a/bin/logging b/bin/logging
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 #
 # Constants & functions for logging.
 #
diff --git a/bin/watch b/bin/watch
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 #
 # Watch $SRC, re-build when any file changes.
 #
diff --git a/defaults.yml b/defaults.yml
@@ -1,3 +1,2 @@
-lang: en-US
-from: gfm+raw_html
-to: html
+header-includes:
+  - <meta property="og:image" content="/assets/kraftwerk.webp">
diff --git a/src/about.md b/src/about.md
diff --git a/src/blog.md b/src/blog.md
@@ -2,6 +2,9 @@
 title: Blog
 ---
 
+## 2025
+- [Cool museum](/cool-museum/)
+
 ## 2023
 - [Can't Stop Blogging](/cant-stop-blogging/)
 - [New Blog](/new-blog/)
diff --git a/src/cool-museum.md b/src/cool-museum.md
@@ -0,0 +1,8 @@
+---
+title: Contemporary Art in Bangkok!
+date: 2025-03-08
+---
+
+I love this painting I saw on my trip to Thailand!
+
+![Birth, Aging, Dying](/assets/birth-aging-dying.webp)
diff --git a/static/css/main.css b/static/css/main.css
@@ -23,3 +23,7 @@ nav ul li {
     margin-right: 20px;
     line-height: 2.5em;
 }
+
+img {
+    max-width: 95%;
+}
diff --git a/template/footer.html b/template/footer.html
diff --git a/template/header.html b/template/header.html

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`		`-#!/bin/sh`
	`1`	`+#!/usr/bin/env sh`
`2`	`2`	`set -e`
`3`	`3`	`#`
`4`	`4`	`# Install pandoc on debian.`
`5`	`5`	`#`
`6`		`-`
`7`		`-curl -O -L -C - https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-1-amd64.deb`
`8`		`-sudo dpkg -i pandoc-2.19.2-1-amd64.deb`
`9`		`-rm pandoc-2.19.2-1-amd64.deb`
	`6`	`+VERSION="3.6.3"`
	`7`	`+curl -o pandoc.deb -L -C - "https://github.com/jgm/pandoc/releases/download/$VERSION/pandoc-$VERSION-1-amd64.deb"`
	`8`	`+sudo dpkg -i pandoc.deb`
	`9`	`+rm pandoc.deb`
`10`	`10`
`11`	`11`	`#`
`12`	`12`	`# Install pandoc-rss on debian.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/bin/sh`
	`1`	`+#!/usr/bin/env sh`
`2`	`2`	`#`
`3`	`3`	`# Constants & functions for logging.`
`4`	`4`	`#`
Original file line number	Diff line number	Diff line change
`@@ -23,3 +23,7 @@ nav ul li {`
`23`	`23`	`margin-right: 20px;`
`24`	`24`	`line-height: 2.5em;`
`25`	`25`	`}`
	`26`	`+`
	`27`	`+img {`
	`28`	`+ max-width: 95%;`
	`29`	`+}`