functionality: Dynamic page titles, versioning, automatic 404 page

.gitea/workflows/lint.yml

@@ -13,4 +13,4 @@ jobs:
       - name: Install Shellcheck
         run: sudo apt-get update && sudo apt-get install -y shellcheck
       - name: Run Shellcheck
-        run: shellcheck kewt.sh markdown.sh tools/build-standalone.sh || true
+        run: shellcheck -s sh kewt.sh markdown.sh tools/build-standalone.sh || true

README.md

@@ -100,7 +100,6 @@ favicon = ""
 
 ## Credits
 
-- Markdown to html conversion based on [markdown.bash](https://github.com/chadbraunduin/markdown.bash) by [chadbraunduin](https://github.com/chadbraunduin)
 - Default css style and html template based on _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23)
 
 >[!WARNING]

kewt.sh

@@ -6,11 +6,12 @@ die() {
 }
 
 usage() {
+    invoked_as=$(basename "${KEWT_INVOKED_AS:-$0}")
     cat <<EOF
-Usage: $0 [--from <src>] [--to <out>]
-       $0 [src] [out]
-       $0 --new [title]
-       $0 --help
+Usage: $invoked_as [--from <src>] [--to <out>]
+       $invoked_as [src] [out]
+       $invoked_as --new [title]
+       $invoked_as --help
 
 Options:
   --help         Show this help message.
@@ -23,6 +24,9 @@ EOF
 script_dir=$(CDPATH="" cd -- "$(dirname -- "$0")" && pwd)
 awk_dir="$script_dir/awk"
 
+KEWT_TMPDIR=$(mktemp -d "/tmp/kewt_run.XXXXXX")
+trap 'rm -rf "$KEWT_TMPDIR"' EXIT HUP INT TERM
+
 ensure_root_defaults() {
     if [ ! -f "./site.conf" ]; then
         cat > "./site.conf" <<'EOF'
@@ -42,6 +46,9 @@ display_logo = false
 display_title = true
 logo_as_favicon = true
 favicon = ""
+generate_page_title = true
+error_page = "not_found.html"
+versioning = false
 EOF
     fi
 
@@ -151,7 +158,14 @@ ensure_root_defaults
 src="${src%/}"
 out="${out%/}"
 
-[ -d "$src" ] || die "Source directory '$src' does not exist."
+if [ ! -d "$src" ]; then
+    if [ "$src" = "site" ]; then
+        usage
+        exit 1
+    else
+        die "Source directory '$src' does not exist."
+    fi
+fi
 
 IGNORE_ARGS="-name '.kewtignore' -o -path '$src/.*'"
 
@@ -174,14 +188,14 @@ if [ -f "$src/.kewtignore" ]; then
     done < "$src/.kewtignore"
 fi
 
-find "$src" -name .kewtignore > "/tmp/kewt_ignore_$$"
+find "$src" -name .kewtignore > "$KEWT_TMPDIR/kewt_ignore"
 while read -r ki; do
     d="${ki%/.kewtignore}"
     if [ "$d" != "$src" ] && [ "$d" != "." ]; then
         IGNORE_ARGS="$IGNORE_ARGS -o -path '$d' -o -path '$d/*'"
     fi
-done < "/tmp/kewt_ignore_$$"
-rm -f "/tmp/kewt_ignore_$$"
+done < "$KEWT_TMPDIR/kewt_ignore"
+rm -f "$KEWT_TMPDIR/kewt_ignore"
 
 HIDE_ARGS="-name '.kewtignore' -o -name '.kewthide' -o -name '.kewtpreserve' -o -path '$src/.*'"
 
@@ -204,14 +218,14 @@ if [ -f "$src/.kewthide" ]; then
     done < "$src/.kewthide"
 fi
 
-find "$src" -name .kewthide > "/tmp/kewt_hide_$$"
+find "$src" -name .kewthide > "$KEWT_TMPDIR/kewt_hide"
 while read -r kh; do
     d="${kh%/.kewthide}"
     if [ "$d" != "$src" ] && [ "$d" != "." ]; then
         HIDE_ARGS="$HIDE_ARGS -o -path '$d' -o -path '$d/*'"
     fi
-done < "/tmp/kewt_hide_$$"
-rm -f "/tmp/kewt_hide_$$"
+done < "$KEWT_TMPDIR/kewt_hide"
+rm -f "$KEWT_TMPDIR/kewt_hide"
 
 PRESERVE_ARGS="-false"
 
@@ -234,14 +248,14 @@ if [ -f "$src/.kewtpreserve" ]; then
     done < "$src/.kewtpreserve"
 fi
 
-find "$src" -name .kewtpreserve > "/tmp/kewt_preserve_$$"
+find "$src" -name .kewtpreserve > "$KEWT_TMPDIR/kewt_preserve"
 while read -r kp; do
     d="${kp%/.kewtpreserve}"
     if [ "$d" != "$src" ] && [ "$d" != "." ]; then
         PRESERVE_ARGS="$PRESERVE_ARGS -o -path '$d' -o -path '$d/*'"
     fi
-done < "/tmp/kewt_preserve_$$"
-rm -f "/tmp/kewt_preserve_$$"
+done < "$KEWT_TMPDIR/kewt_preserve"
+rm -f "$KEWT_TMPDIR/kewt_preserve"
 
 generate_nav() {
     dinfo=$(eval "find \"$1\" \( $IGNORE_ARGS -o $HIDE_ARGS -o $PRESERVE_ARGS \) -prune -o -print" | sort | awk -v src="$1" -f "$awk_dir/collect_dir_info.awk")
@@ -265,6 +279,9 @@ display_logo="false"
 display_title="true"
 logo_as_favicon="true"
 favicon=""
+generate_page_title="true"
+error_page="not_found.html"
+versioning="false"
 
 load_config() {
     [ -f "$1" ] || return
@@ -302,6 +319,9 @@ load_config() {
             display_title) display_title="$val" ;;
             logo_as_favicon) logo_as_favicon="$val" ;;
             favicon) favicon="$val" ;;
+            generate_page_title) generate_page_title="$val" ;;
+            error_page) error_page="$val" ;;
+            versioning) versioning="$val" ;;
         esac
     done < "$1"
 }
@@ -309,6 +329,11 @@ load_config() {
 load_config "./site.conf"
 load_config "$src/site.conf"
 
+asset_version=""
+if [ "$versioning" = "true" ]; then
+    asset_version="?v=$(date +%s)"
+fi
+
 escape_html_text() {
     printf '%s' "$1" | sed \
         -e 's/&/\&amp;/g' \
@@ -458,7 +483,21 @@ render_markdown() {
         head_extra="<link rel=\"icon\" href=\"$favicon_src\" />"
     fi
 
-    MARKDOWN_SITE_ROOT="$src" MARKDOWN_FALLBACK_FILE="$script_dir/styles/$style.css" sh "$script_dir/markdown.sh" "$file" | awk -v title="$title" -v nav="$nav" -v footer="$footer" -v style_path="$style_path" -v header_brand="$header_brand" -v head_extra="$head_extra" -f "$awk_dir/render_template.awk" "$local_template"
+    page_title="$title"
+    if [ "$generate_page_title" = "true" ] && [ -n "$file" ] && [ -f "$file" ]; then
+        first_heading=$(grep -m 1 '^# ' "$file" | sed 's/^# *//; s/ *$//')
+        if [ -n "$first_heading" ]; then
+            page_title="$first_heading - $title"
+        else
+            basename_no_ext=$(basename "$file" .md)
+            if [ "$basename_no_ext" != "index" ] && [ "$basename_no_ext" != "404_gen" ]; then
+                cap_basename=$(echo "$basename_no_ext" | awk '{print toupper(substr($0,1,1)) substr($0,2)}')
+                page_title="$cap_basename - $title"
+            fi
+        fi
+    fi
+
+    MARKDOWN_SITE_ROOT="$src" MARKDOWN_FALLBACK_FILE="$script_dir/styles/$style.css" sh "$script_dir/markdown.sh" "$file" | awk -v title="$page_title" -v nav="$nav" -v footer="$footer" -v style_path="${style_path}${asset_version}" -v header_brand="$header_brand" -v head_extra="$head_extra" -f "$awk_dir/render_template.awk" "$local_template"
 }
 
 echo "Building site from '$src' to '$out'..."
@@ -488,7 +527,7 @@ eval "find \"$src\" \( $IGNORE_ARGS \) -prune -o -type d -print" | sort | while
             fi
         fi
 
-        temp_index="/tmp/kewt_index_$$.md"
+        temp_index="$KEWT_TMPDIR/index.md"
         display_dir="${rel_dir#.}"
         [ -z "$display_dir" ] && display_dir="/"
         echo "# Index of $display_dir" > "$temp_index"
@@ -543,5 +582,13 @@ eval "find \"$src\" \( $IGNORE_ARGS \) -prune -o -type f -print" | sort | while
     fi
 done
 
+if [ -n "$error_page" ] && [ ! -f "$out/$error_page" ]; then
+    temp_404="$KEWT_TMPDIR/404_gen.md"
+    echo "# 404 - Not Found" > "$temp_404"
+    echo "" >> "$temp_404"
+    echo "The requested page could not be found." >> "$temp_404"
+    render_markdown "$temp_404" > "$out/$error_page"
+    rm -f "$temp_404"
+fi
 
 echo "Build complete."

site/index.md

@@ -100,7 +100,6 @@ favicon = ""
 
 ## Credits
 
-- Markdown to html conversion based on [markdown.bash](https://github.com/chadbraunduin/markdown.bash) by [chadbraunduin](https://github.com/chadbraunduin)
 - Default css style and html template based on _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23)
 
 >![WARNING]

tools/build-standalone.sh

@@ -20,7 +20,8 @@ trap 'rm -rf "$tmpdir"' EXIT HUP INT TERM
 sed '1,/^#==PAYLOAD==$/d' "$0" | tar -xz -C "$tmpdir"
 
 # Pass control to the extracted script
-exec "$tmpdir/kewt.sh" "$@"
+KEWT_INVOKED_AS="$0" "$tmpdir/kewt.sh" "$@"
+exit $?
 
 #==PAYLOAD==
 EOF