Add data-pagefind-body to main content element

In preparation for adding Pagefind search support to bbaovanc.com. Those
templates will just go in the bbaovanc.com tree instead.

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "assets/jam"]
 	path = assets/jam
-	url = https://github.com/michaelampr/jam.git
+	url = https://github.com/BBaoVanC/jam.git
 	branch = master

assets/css/bobastyle.css

@@ -248,31 +248,31 @@ hr {
   }
 }
 
-table.markdown {
+table.simple {
   border-collapse: collapse;
   border: 2px solid var(--text-1);
 }
 
-table.markdown thead {
+table.simple thead {
   background-color: var(--background-2);
   color: var(--text-2);
   border-bottom: 2px solid var(--text-1);
 }
 
-table.markdown th,
+table.simple th,
-table.markdown td {
+table.simple td {
   padding: 8px;
 }
 
-table.markdown :is(th, td) + :is(th, td) {
+table.simple :is(th, td) + :is(th, td) {
   border-left: 2px solid var(--text-1);
 }
 
-table.markdown tbody tr:nth-child(odd) {
+table.simple tbody tr:nth-child(odd) {
   background-color: var(--background-0);
   color: var(--text-0);
 }
-table.markdown tbody tr:nth-child(even) {
+table.simple tbody tr:nth-child(even) {
   background-color: var(--background-1);
   color: var(--text-1);
 }
@@ -291,17 +291,17 @@ table.markdown tbody tr:nth-child(even) {
 
 /* Icons */
 .icon {
-  width: 20px;
+  width: 1em;
-  height: 20px;
+  height: 1em;
   color: var(--text-1);
   text-align: center;
   display: inline;
-  vertical-align: middle;
+  vertical-align: sub;
 }
 
-h1 svg.icon {
+/* workarounds for some icons from jam-icons being non-square aspect ratio */
-  width: 30px;
+.icon-code {
-  height: 30px;
+  width: 1.25em;
 }
 
 /* }}} */
@@ -315,11 +315,6 @@ h1 svg.icon {
   font-weight: bold;
 }
 
-.heading-link svg {
-  width: 15px;
-  height: 15px;
-}
-
 /* }}} */
 
 /* Top bar formatting {{{ */
@@ -676,6 +671,7 @@ h1 svg.icon {
   display: flex;
   gap: 8px;
   justify-content: center;
+  font-size: 32px;
 }
 
 .share-buttons a {
@@ -690,8 +686,7 @@ h1 svg.icon {
 }
 
 .share-buttons svg {
-  width: 32px;
+  display: block;
-  height: 32px;
 }
 
 /* https://stackoverflow.com/a/72073682/19003757 */

assets/css/syntax-light.css

@@ -5,16 +5,17 @@
     color: black;
   }
 
-/* Background */ .bg { background-color: #f8f8f8 }
+/* Background */ .bg { background-color: #f8f8f8; }
 /* PreWrapper */ .chroma { background-color: #f8f8f8; }
 /* Other */ .chroma .x { color: #000000 }
 /* Error */ .chroma .err { color: #a40000 }
 /* CodeLine */ .chroma .cl {  }
+/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
 /* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
 /* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
-/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
+/* LineHighlight */ .chroma .hl { background-color: #dfdfdf }
-/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
+/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
-/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
+/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
 /* Line */ .chroma .line { display: flex; }
 /* Keyword */ .chroma .k { color: #204a87; font-weight: bold }
 /* KeywordConstant */ .chroma .kc { color: #204a87; font-weight: bold }

assets/css/syntax.css

@@ -1,15 +1,16 @@
 /* native style */
 
-/* Background */ .bg { color: #d0d0d0; background-color: #202020 }
+/* Background */ .bg { color: #d0d0d0; background-color: #202020; }
 /* PreWrapper */ .chroma { color: #d0d0d0; background-color: #202020; }
 /* Other */ .chroma .x {  }
 /* Error */ .chroma .err { color: #a61717; background-color: #e3d2d2 }
 /* CodeLine */ .chroma .cl {  }
+/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
 /* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
 /* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
-/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
+/* LineHighlight */ .chroma .hl { background-color: #363636 }
-/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #686868 }
+/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #686868 }
-/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #686868 }
+/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #686868 }
 /* Line */ .chroma .line { display: flex; }
 /* Keyword */ .chroma .k { color: #6ab825; font-weight: bold }
 /* KeywordConstant */ .chroma .kc { color: #6ab825; font-weight: bold }

assets/js/share-event.js

@@ -1,3 +0,0 @@
-function share_event(service) {
-    // this function does nothing by default
-}

exampleSite/hugo.yaml

@@ -1,60 +0,0 @@
-baseURL: https://example.com
-theme: bobatheme
-defaultContentLanguage: en
-copyright: '&copy; 2021 bbaovanc <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>'
-sectionPagesMenu: main
-enableRobotsTXT: true
-paginate: 5
-enableGitInfo: true
-
-taxonomies:
-  _merge: deep
-
-markup: # this just keeps the bobatheme markup styling
-  _merge: deep
-
-params:
-  author:
-    name: bbaovanc
-
-  # these are for the OpenGraph/Twitter embeds in Hugo
-  description: Example website for bobatheme
-
-  # these are for favicons in bobatheme (disabled by default)
-  # faviconSVG: favicon.svg
-  # appleTouchPNG: apple-touch-icon.png
-
-  # show reading time (enabled by default)
-  # readingtime: true
-
-  # used for "View source" (unset by default)
-  # gitFileURL: https://github.com/BBaoVanC/bobatheme/blob/master
-  # gitFileIcon: github-circle
-  # gitHistoryURL: https://github.com/BBaoVanC/bobatheme/commits/master
-
-  # social media share icons
-  # shareButtons:
-  #   twitter: true
-  #   facebook: true
-  #   linkedin: true
-  #   reddit: true
-  #   telegram: true
-  #   print: true
-
-  # show "Latest Posts" section at bottom of content pages
-  # latestPostsOnContent: true
-
-  # footer: >-
-  #   Some example text for the footer.
-
-
-# see https://gohugo.io/about/hugo-and-gdpr/#all-privacy-settings
-# you probably want to keep this default
-privacy:
-  _merge: deep
-
-languages:
-  en:
-    languageName: English
-    title: Example Website
-    weight: 1

hugo.yaml

@@ -2,6 +2,12 @@ markup:
   highlight:
     noClasses: false
     lineNos: true
+  goldmark:
+    parser:
+      attribute:
+        block: true
+        # this is enabled by default already
+        #title: true
 
 params:
   readingtime: true
@@ -12,11 +18,20 @@ taxonomies:
   author: authors
   series: series
 
+outputs:
+  page:
+    - html
+    - markdown
+
+outputFormats:
+  markdown:
+    ugly: true
+
 privacy:
   googleAnalytics:
     disable: true
 
-  twitter:
+  x:
     enableDNT: true
 
   vimeo:

i18n/en.yaml

@@ -30,6 +30,9 @@ readingtime:
 edit_history:
   other: "Edit history"
 
+view_markdown:
+  other: "View raw"
+
 
 # Post count
 no_posts:
@@ -67,6 +70,9 @@ aria_rss_link:
 aria_post_meta_edit_history:
   other: "link to page edit history"
 
+aria_post_meta_view_markdown:
+  other: "link to view raw markdown code of page"
+
 aria_post_meta_categories:
   other: "categories"
 

layouts/_partials/_internal/pagination.html

@@ -0,0 +1,154 @@
+{{- $validFormats := slice "default" "terse" }}
+
+{{- $msg1 := "When passing a map to the internal pagination template, one of the elements must be named 'page', and it must be set to the context of the current page." }}
+{{- $msg2 := "The 'format' specified in the map passed to the internal pagination template is invalid. Valid choices are: %s." }}
+
+{{- $page := . }}
+{{- $format := "default" }}
+
+{{- if reflect.IsMap . }}
+  {{- with .page }}
+    {{- $page = . }}
+  {{- else }}
+    {{- errorf $msg1 }}
+  {{- end }}
+  {{- with .format }}
+    {{- $format = lower . }}
+  {{- end }}
+{{- end }}
+
+{{- if in $validFormats $format }}
+  {{- if gt $page.Paginator.TotalPages 1 }}
+    <ul class="pagination pagination-{{ $format }}">
+      {{- partial (printf "inline/pagination/%s.html" $format) $page }}
+    </ul>
+  {{- end }}
+{{- else }}
+  {{- errorf $msg2 (delimit $validFormats ", ") }}
+{{- end -}}
+
+{{/* Format: default
+{{/* --------------------------------------------------------------------- */}}
+{{- define "_partials/inline/pagination/default.html" }}
+  {{- with .Paginator }}
+    {{- $currentPageNumber := .PageNumber }}
+
+    {{- with .First }}
+      {{- if ne $currentPageNumber .PageNumber }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="First" class="page-link" role="button"><span aria-hidden="true">&laquo;&laquo;</span></a>
+      </li>
+      {{- else }}
+      <li class="page-item disabled">
+        <a aria-disabled="true" aria-label="First" class="page-link" role="button" tabindex="-1"><span aria-hidden="true">&laquo;&laquo;</span></a>
+      </li>
+      {{- end }}
+    {{- end }}
+
+    {{- with .Prev }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Previous" class="page-link" role="button"><span aria-hidden="true">&laquo;</span></a>
+      </li>
+    {{- else }}
+      <li class="page-item disabled">
+        <a aria-disabled="true" aria-label="Previous" class="page-link" role="button" tabindex="-1"><span aria-hidden="true">&laquo;</span></a>
+      </li>
+    {{- end }}
+
+    {{- $slots := 5 }}
+    {{- $start := math.Max 1 (sub .PageNumber (math.Floor (div $slots 2))) }}
+    {{- $end := math.Min .TotalPages (sub (add $start $slots) 1) }}
+    {{- if lt (add (sub $end $start) 1) $slots }}
+      {{- $start = math.Max 1 (add (sub $end $slots) 1) }}
+    {{- end }}
+
+    {{- range $k := seq $start $end }}
+      {{- if eq $.Paginator.PageNumber $k }}
+      <li class="page-item active">
+        <a aria-current="page" aria-label="Page {{ $k }}" class="page-link" role="button">{{ $k }}</a>
+      </li>
+      {{- else }}
+      <li class="page-item">
+        <a href="{{ (index $.Paginator.Pagers (sub $k 1)).URL }}" aria-label="Page {{ $k }}" class="page-link" role="button">{{ $k }}</a>
+      </li>
+      {{- end }}
+    {{- end }}
+
+    {{- with .Next }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Next" class="page-link" role="button"><span aria-hidden="true">&raquo;</span></a>
+      </li>
+    {{- else }}
+      <li class="page-item disabled">
+        <a aria-disabled="true" aria-label="Next" class="page-link" role="button" tabindex="-1"><span aria-hidden="true">&raquo;</span></a>
+      </li>
+    {{- end }}
+
+    {{- with .Last }}
+      {{- if ne $currentPageNumber .PageNumber }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Last" class="page-link" role="button"><span aria-hidden="true">&raquo;&raquo;</span></a>
+      </li>
+      {{- else }}
+      <li class="page-item disabled">
+        <a aria-disabled="true" aria-label="Last" class="page-link" role="button" tabindex="-1"><span aria-hidden="true">&raquo;&raquo;</span></a>
+      </li>
+      {{- end }}
+    {{- end }}
+  {{- end }}
+{{- end -}}
+
+{{/* Format: terse
+{{/* --------------------------------------------------------------------- */}}
+{{- define "_partials/inline/pagination/terse.html" }}
+  {{- with .Paginator }}
+    {{- $currentPageNumber := .PageNumber }}
+
+    {{- with .First }}
+      {{- if ne $currentPageNumber .PageNumber }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="First" class="page-link" role="button"><span aria-hidden="true">&laquo;&laquo;</span></a>
+      </li>
+      {{- end }}
+    {{- end }}
+
+    {{- with .Prev }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Previous" class="page-link" role="button"><span aria-hidden="true">&laquo;</span></a>
+      </li>
+    {{- end }}
+
+    {{- $slots := 3 }}
+    {{- $start := math.Max 1 (sub .PageNumber (math.Floor (div $slots 2))) }}
+    {{- $end := math.Min .TotalPages (sub (add $start $slots) 1) }}
+    {{- if lt (add (sub $end $start) 1) $slots }}
+      {{- $start = math.Max 1 (add (sub $end $slots) 1) }}
+    {{- end }}
+
+    {{- range $k := seq $start $end }}
+      {{- if eq $.Paginator.PageNumber $k }}
+      <li class="page-item active">
+        <a aria-current="page" aria-label="Page {{ $k }}" class="page-link" role="button">{{ $k }}</a>
+      </li>
+      {{- else }}
+      <li class="page-item">
+        <a href="{{ (index $.Paginator.Pagers (sub $k 1)).URL }}" aria-label="Page {{ $k }}" class="page-link" role="button">{{ $k }}</a>
+      </li>
+      {{- end }}
+    {{- end }}
+
+    {{- with .Next }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Next" class="page-link" role="button"><span aria-hidden="true">&raquo;</span></a>
+      </li>
+    {{- end }}
+
+    {{- with .Last }}
+      {{- if ne $currentPageNumber .PageNumber }}
+      <li class="page-item">
+        <a href="{{ .URL }}" aria-label="Last" class="page-link" role="button"><span aria-hidden="true">&raquo;&raquo;</span></a>
+      </li>
+      {{- end }}
+    {{- end }}
+  {{- end }}
+{{- end -}}

layouts/_partials/head.html

@@ -16,9 +16,6 @@
     {{ with resources.Get "js/bobatheme.js" | fingerprint "sha512" }}
         <script defer src="{{ .Permalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous"></script>
     {{ end }}
-    {{ with resources.Get "js/share-event.js" | fingerprint "sha512" }}
-        <script defer src="{{ .Permalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous"></script>
-    {{ end }}
 
     {{ with .Site.Params.faviconSVG }}
         <link rel="icon" href="{{ . | absURL }}" />

layouts/_partials/icon_code.html

@@ -1,6 +1,6 @@
 {{- $icon_resource := resources.Get (printf "jam/icons/%s.svg" .) -}}
 {{- $icon := $icon_resource.Content -}}
-{{- $icon = replaceRE `<svg` `<svg class="icon"` $icon -}}
+{{- $icon = replaceRE `<svg` (printf `<svg class="icon icon-%s"` .) $icon -}}
 {{- $icon = replaceRE `</svg>` (printf `<title>%s icon</title></svg>` .) $icon -}}
 {{- $icon = replaceRE `(width|height)="[0-9]*"` "" $icon -}}
 {{- $icon | safeHTML -}}

layouts/_partials/page-metadata/custom-full.html

@@ -0,0 +1 @@
+<!-- Placeholder for website to add custom post metadata to summaries -->

layouts/_partials/page-metadata/item/viewraw.html

@@ -0,0 +1,8 @@
+{{ with .OutputFormats.Get "markdown" }}
+    <span class="page-metadata-item post-meta-view-markdown" aria-label="{{ i18n "aria_post_meta_view_markdown" }}">
+        {{ partial "icon.html" "code" }}
+        <a href="{{ .Permalink }}" target="_blank">
+            {{- i18n "view_markdown" -}}
+        </a>
+    </span>
+{{ end }}

layouts/_partials/page-metadata/post-full.html

@@ -20,7 +20,12 @@
         {{ partial "page-metadata/item/authors.html" . }}
         {{ partial "page-metadata/item/readingtime.html" . }}
         {{ partial "page-metadata/item/edithistory.html" . }}
+        {{ partial "page-metadata/item/viewraw.html" . }}
+
+        {{ partial "page-metadata/custom-full.html" . }}
+
         {{ partial "page-metadata/item/categories.html" . }}
+
         {{ partial "page-metadata/item/tags.html" . }}
     </div>
 {{ end }}

layouts/_partials/page-metadata/post-short.html

@@ -9,6 +9,7 @@
 
         {{ partial "page-metadata/item/authors.html" . }}
         {{ partial "page-metadata/item/readingtime.html" . }}
+
         {{ partial "page-metadata/item/series.html" . }}
         {{ partial "page-metadata/item/categories.html" . }}
         {{ partial "page-metadata/item/tags.html" . }}

layouts/_partials/pagination.html

@@ -0,0 +1,6 @@
+{{ if gt .Paginator.TotalPages 1 }}
+    <nav class="pagination">
+        {{/* https://github.com/gohugoio/hugo/blob/a88b488181279befd50e1d127f9f67604f2f9854/tpl/tplimpl/embedded/templates/_partials/pagination.html */}}
+        {{ partial "_internal/pagination.html" . }}
+    </nav>
+{{ end }}

layouts/_partials/seo-tags/opengraph.html

@@ -33,7 +33,7 @@
     <meta property="og:locale" content="{{ . }}">
 {{ end }}
 
-{{ with .Site.Params.title }}
+{{ with .Site.Title }}
     <meta property="og:site_name" content="{{ . }}">
 {{ end }}
 

layouts/_partials/seo-tags/schema.html

@@ -21,10 +21,14 @@
     <meta itemprop="image" content="{{ $featured.Permalink }}">
 {{ end }}
 
-{{ with (.GetTerms "tags") }}
+{{ with .Keywords }}
-    {{ $tags := slice }}
+    <meta itemprop="keywords" content="{{ delimit . ", " }}">
-    {{ range . }}
+{{ else }}
-        {{ $tags = $tags | append .LinkTitle }}
+    {{ with (.GetTerms "tags") }}
+        {{ $tags := slice }}
+        {{ range . }}
+            {{ $tags = $tags | append .LinkTitle }}
+        {{ end }}
+        <meta itemprop="keywords" content="{{ delimit $tags ", " }}">
     {{ end }}
-    <meta itemprop="keywords" content="{{ delimit $tags ", " }}">
 {{ end }}

layouts/_partials/seo-tags/twitter-cards.html

@@ -24,6 +24,6 @@
 <meta name="twitter:title" content="{{ .Title | plainify }}">
 <meta name="twitter:description" content="{{ (partial "seo-description.html" .) | plainify }}">
 
-{{ with .Site.Social.twitter }}
+{{ with .Site.Params.social.twitter }}
     <meta name="twitter:site" content="@{{ . }}">
 {{ end }}

layouts/_shortcodes/include.html

@@ -0,0 +1,14 @@
+{{/* https://github.com/gohugoio/hugo/issues/13823#issuecomment-3015270202 */}}
+{{ with .Get 0 -}}
+    {{ with $.Page.GetPage . -}}
+        {{ .RenderShortcodes -}}
+    {{ else with $.Page.Resources.Get . -}}
+        {{ .RenderShortcodes -}}
+    {{ else with resources.Get . -}}
+        {{ .Content -}}
+    {{ else -}}
+        {{ errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position -}}
+    {{ end -}}
+{{ else -}}
+    {{ errorf "The %q shortcode requires a positional parameter indicating the logical path of the file to include. See %s" .Name .Position -}}
+{{ end -}}

layouts/baseof.html

@@ -8,12 +8,18 @@
 
         {{ partial "top.html" . }}
 
+        {{ if hugo.IsServer -}}
+            <div style="position: fixed; bottom: 25px; right: 25px;">
+                {{ templates.Current.Name }}
+            </div>
+        {{ end -}}
+
         <div class="main-container">
             {{ if not .IsHome }}
                 {{ partial "breadcrumb.html" . }}
             {{ end }}
 
-            <main id="main-content">
+            <main id="main-content" data-pagefind-body>
                 {{ block "main" . }}
                     THIS TEXT SHOULD NOT SHOW. YUZSIQGHE (that string is so I can grep for it)
                 {{ end }}
@@ -27,7 +33,7 @@
         {{ if or .Site.Copyright .Site.Params.footer }}
             <footer>
                 {{ with .Site.Copyright }}
-                    <p>{{ . | safeHTML }}</p>
+                    {{ . | safeHTML }}
                 {{ end }}
 
                 {{ with .Site.Params.footer }}

layouts/partials/pagination.html

@@ -1,5 +0,0 @@
-{{ if gt .Paginator.TotalPages 1 }}
-    <nav class="pagination">
-        {{ template "_internal/pagination.html" . }}
-    </nav>
-{{ end }}

layouts/shortcodes/include.html

@@ -1,20 +0,0 @@
-{{ $path := "" }}
-{{ $markdown := false }}
-{{ if .IsNamedParams }}
-    {{ $path = .Get "path" }}
-    {{ with .Get "markdown" }}
-        {{ $markdown = . }}
-    {{ end }}
-{{ else }}
-    {{ $path = .Get 0 }}
-{{ end }}
-
-{{ with ($path | readFile) }}
-    {{ if $markdown }}
-        {{ $path | readFile | $.Page.RenderString (dict "display" "block") }}
-    {{ else }}
-        {{ $path | readFile }}
-    {{ end }}
-{{ else }}
-    {{ errorf "file not found: %s" $path }}
-{{ end }}

layouts/shortcodes/table.html

@@ -1,10 +0,0 @@
-{{/* See https://willschenk.com/articles/2020/styling_tables_with_hugo/ */}}
-
-{{ $class := "markdown" }}
-{{ with .Get "class" }}
-    {{ $class = delimit (slice $class .) " " }}
-{{ end }}
-
-{{ $htmlTable := .Inner | .Page.RenderString (dict "display" "block") }}
-{{ $new := printf `<table class="%s">` $class }}
-{{ (replace $htmlTable "<table>" $new) | safeHTML }}

layouts/single.markdown.md

@@ -0,0 +1,9 @@
+{{ with .File -}}
+  {{ with (.Path | readFile) -}}
+    {{ . -}}
+  {{ else -}}
+    {{ errorf "file not found: %s" .Path -}}
+  {{ end -}}
+{{ else -}}
+  {{ errorf "no file available for markdown template?" -}}
+{{ end -}}