feat: an "end" partial

* feat: support GoatCounter analytics

* docs: add docs for GoatCounter analytics

refactor: move analytics documentation into its own section since there are now 4 supported analytics solutions

* fix: addressing issues raised in PR

* refactor: simplifying goat counter setting logic.
refactor: simplify error handling with goat counter

* fix: fixing goat counter erroring when a code is provided

* fix: Applying suggested fixes

* Update layouts/_partials/components/analytics/goat-counter.html

---------

Co-authored-by: Xin <5097752+imfing@users.noreply.github.com>

assets/css/typography.css

@@ -33,19 +33,19 @@
     @apply hx:border-black/4 hx:bg-black/3 hx:break-words hx:rounded-md hx:border hx:py-0.5 hx:px-[.25em] hx:text-[.9em] hx:dark:border-white/10 hx:dark:bg-white/10;
   }
   :where(table):not(:where(.hextra-code-block table, [class~=not-prose],[class~=not-prose] *)) {
-    @apply hx:block hx:overflow-x-auto hx:my-6 hx:p-0 hx:first:mt-0 hx:w-full hx:text-sm hx:leading-5;
+    @apply hx:block hx:overflow-x-auto hx:my-6 hx:p-0 hx:first:mt-0 hx:w-full hx:text-sm hx:leading-5 hx:border-collapse;
 
     thead {
-      @apply hx:border-b hx:border-gray-200 hx:dark:border-neutral-800;
+      @apply hx:bg-gray-50 hx:dark:bg-gray-600/20;
     }
-    tbody tr {
+    tr {
-      @apply hx:m-0 hx:border-b hx:border-gray-100 hx:dark:border-neutral-800/50;
+      @apply hx:m-0 hx:border-t hx:border-gray-300 hx:p-0 hx:dark:border-gray-600;
     }
     th {
-      @apply hx:m-0 hx:p-2 hx:font-semibold hx:first:pl-0 hx:last:pr-0;
+      @apply hx:m-0 hx:border hx:border-gray-300 hx:p-2 hx:font-semibold hx:dark:border-gray-600;
     }
     td {
-      @apply hx:m-0 hx:p-2 hx:first:pl-0 hx:last:pr-0;
+      @apply hx:m-0 hx:border hx:border-gray-300 hx:p-2 hx:dark:border-gray-600;
     }
   }
   :where(ol):not(:where([class~=not-prose],[class~=not-prose] *)) {

docs/content/docs/guide/configuration.md

@@ -383,16 +383,6 @@ excludeSearch: true
 ---
 ```
 
-### Google Analytics
-
-To enable [Google Analytics](https://marketingplatform.google.com/about/analytics/), set `services.googleAnalytics.ID` flag in `hugo.yaml`:
-
-```yaml {filename="hugo.yaml"}
-services:
-  googleAnalytics:
-    ID: G-MEASUREMENT_ID
-```
-
 ### Google Search Index
 
 To [block Google Search](https://developers.google.com/search/docs/crawling-indexing/block-indexing) from indexing a page, set `noindex` to true in your page frontmatter:
@@ -409,7 +399,25 @@ To exclude an entire directory, use the [`cascade`](https://gohugo.io/configurat
 > To block search crawlers, you can make a [`robots.txt` template](https://gohugo.io/templates/robots/).
 > However, `robots.txt` instructions do not necessarily keep a page out of Google search results.
 
-### Umami Analytics
+### Analytics
+
+Hextra has support for several different analytics solutions. Hextra only supports analytics in production environments. This is to ensure that you do not accidentally send analytic events when working locally. If, however, you do want to test analytics locally, you can run a production server using:
+
+```
+hugo server --environment production
+```
+
+#### Google Analytics
+
+To enable [Google Analytics](https://marketingplatform.google.com/about/analytics/), set `services.googleAnalytics.ID` flag in `hugo.yaml`:
+
+```yaml {filename="hugo.yaml"}
+services:
+  googleAnalytics:
+    ID: G-MEASUREMENT_ID
+```
+
+#### Umami Analytics
 
 To enable [Umami](https://umami.is/docs/), set `params.analytics.umami.serverURL` and `params.analytics.umami.websiteID` flag in `hugo.yaml`:
 
@@ -419,7 +427,7 @@ params:
     umami:
       serverURL: "https://example.com"
       websiteID: "94db1cb1-74f4-4a40-ad6c-962362670409"
-      # scriptName: "umami.js" # optional (default: umami.js)
+      # scriptName: "script.js" # optional (default: script.js)
       # https://umami.is/docs/tracker-configuration#data-host-url
       # hostURL: "http://stats.example.org" # optional
       # https://umami.is/docs/tracker-configuration#data-auto-track
@@ -436,7 +444,7 @@ params:
       # doNotTrack: "true" # optional
 ```
 
-### Matomo Analytics
+#### Matomo Analytics
 
 To enable [Matomo](https://matomo.org/), set `params.analytics.matomo.URL` and `params.analytics.matomo.ID` flag in `hugo.yaml`:
 
@@ -448,6 +456,32 @@ params:
       websiteID: "94db1cb1-74f4-4a40-ad6c-962362670409"
 ```
 
+#### GoatCounter Analytics
+
+To enable [GoatCounter](https://www.goatcounter.com/), set `params.analytics.goatCounter.code` in `hugo.yaml`
+All settings available here are mirrors of the settings described in GoatCounter [settings](https://www.goatcounter.com/help/js#settings-44186)
+
+```yaml {filename="hugo.yaml"}
+params:
+  analytics:
+    goatCounter:
+      code: "ABCDE"
+
+      # Optional Settings
+      #------------------
+      # disables automatic collection of data
+      # noOnload: true
+      
+      # disables event binding. See more here https://www.goatcounter.com/help/events
+      # noEvents: true
+
+      # allows data collection from local addresses. Use this with a production environment to test locally
+      # allowLocal: true
+
+      # Allow data collection when a page is loaded in a frame or iframe
+      # allowFrame: true
+```
+
 ### LLMS.txt Support
 
 To enable [llms.txt](https://llmstxt.org/) output format for your site, which provides a structured text outline for [large language models](https://en.wikipedia.org/wiki/Large_language_model) and AI agents, add the `llms` output format to your site's `hugo.yaml`:

docs/content/docs/guide/latex.fa.md

@@ -3,7 +3,7 @@ title: "LaTeX"
 weight: 4
 ---
 
-عبارات ریاضی LaTeX به طور پیش‌فرض با استفاده از \(\KaTeX\) نمایش داده می‌شوند. کافی است آن‌ها را در محتوای Markdown خود قرار دهید بدون نیاز به هیچ پیکربندی دستی.
+عبارات ریاضی LaTeX به طور پیش‌فرض با استفاده از \(\KaTeX\) ([katex.org](https://katex.org/)) نمایش داده می‌شوند. کافی است آن‌ها را در محتوای Markdown خود قرار دهید بدون نیاز به هیچ پیکربندی دستی.
 
 ## نحوه استفاده
 

docs/content/docs/guide/latex.ja.md

@@ -3,7 +3,7 @@ title: "LaTeX"
 weight: 4
 ---
 
-LaTeX の数式表現はデフォルトで \(\KaTeX\) を使用してレンダリングされます。特別な設定なしで、Markdown コンテンツ内に直接記述できます。
+LaTeX の数式表現はデフォルトで \(\KaTeX\) ([katex.org](https://katex.org/)) を使用してレンダリングされます。特別な設定なしで、Markdown コンテンツ内に直接記述できます。
 
 ## 使用方法
 

docs/content/docs/guide/latex.md

@@ -3,7 +3,7 @@ title: "LaTeX"
 weight: 4
 ---
 
-LaTeX math expressions are rendered using \(\KaTeX\) by default. Simply start including them in your Markdown content without any manual configurations.
+LaTeX math expressions are rendered using \(\KaTeX\) ([katex.org](https://katex.org/)) by default. Simply start including them in your Markdown content without any manual configurations.
 
 ## Usage
 

docs/content/docs/guide/shortcodes/details.fa.md

@@ -8,36 +8,36 @@ title: جزئیات
 
 ## مثال
 
-{{% details title="جزئیات" %}}
+{{< details title="جزئیات" >}}
 
 این محتوای جزئیات است.
 
 مارک‌داون **پشتیبانی می‌شود**.
 
-{{% /details %}}
+{{< /details >}}
 
-{{% details title="برای نمایش کلیک کنید" closed="true" %}}
+{{< details title="برای نمایش کلیک کنید" closed="true" >}}
 
 این به‌صورت پیش‌فرض مخفی خواهد بود.
 
-{{% /details %}}
+{{< /details >}}
 
 ## نحوه استفاده
 
 ````markdown
-{{%/* details title="جزئیات" */%}}
+{{</* details title="جزئیات" */>}}
 
 این محتوای جزئیات است.
 
 مارک‌داون **پشتیبانی می‌شود**.
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````
 
 ````markdown
-{{%/* details title="برای نمایش کلیک کنید" closed="true" */%}}
+{{</* details title="برای نمایش کلیک کنید" closed="true" */>}}
 
 این به‌صورت پیش‌فرض مخفی خواهد بود.
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````

docs/content/docs/guide/shortcodes/details.ja.md

@@ -8,36 +8,36 @@ title: 詳細
 
 ## 例
 
-{{% details title="詳細" %}}
+{{< details title="詳細" >}}
 
 これは詳細のコンテンツです。
 
 Markdown は **サポートされています**。
 
-{{% /details %}}
+{{< /details >}}
 
-{{% details title="クリックして表示" closed="true" %}}
+{{< details title="クリックして表示" closed="true" >}}
 
 これはデフォルトで非表示になります。
 
-{{% /details %}}
+{{< /details >}}
 
 ## 使用方法
 
 ````markdown
-{{%/* details title="詳細" */%}}
+{{</* details title="詳細" */>}}
 
 これは詳細のコンテンツです。
 
 Markdown は **サポートされています**。
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````
 
 ````markdown
-{{%/* details title="クリックして表示" closed="true" */%}}
+{{</* details title="クリックして表示" closed="true" */>}}
 
 これはデフォルトで非表示になります。
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````

docs/content/docs/guide/shortcodes/details.md

@@ -8,36 +8,36 @@ A built-in component to display a collapsible content.
 
 ## Example
 
-{{% details title="Details" %}}
+{{< details title="Details" >}}
 
 This is the content of the details.
 
 Markdown is **supported**.
 
-{{% /details %}}
+{{< /details >}}
 
-{{% details title="Click me to reveal" closed="true" %}}
+{{< details title="Click me to reveal" closed="true" >}}
 
 This will be hidden by default.
 
-{{% /details %}}
+{{< /details >}}
 
 ## Usage
 
 ````markdown
-{{%/* details title="Details" */%}}
+{{</* details title="Details" */>}}
 
 This is the content of the details.
 
 Markdown is **supported**.
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````
 
 ````markdown
-{{%/* details title="Click me to reveal" closed="true" */%}}
+{{</* details title="Click me to reveal" closed="true" */>}}
 
 This will be hidden by default.
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````

docs/content/docs/guide/shortcodes/details.zh-cn.md

@@ -8,36 +8,36 @@ title: 详情
 
 ## 示例
 
-{{% details title="详情" %}}
+{{< details title="详情" >}}
 
 这是详情的内容。
 
 支持 **Markdown** 格式。
 
-{{% /details %}}
+{{< /details >}}
 
-{{% details title="点击我展开" closed="true" %}}
+{{< details title="点击我展开" closed="true" >}}
 
 默认情况下，这部分内容会被隐藏。
 
-{{% /details %}}
+{{< /details >}}
 
 ## 使用方法
 
 ````markdown
-{{%/* details title="详情" */%}}
+{{</* details title="详情" */>}}
 
 这是详情的内容。
 
 支持 **Markdown** 格式。
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````
 
 ````markdown
-{{%/* details title="点击我展开" closed="true" */%}}
+{{</* details title="点击我展开" closed="true" */>}}
 
 默认情况下，这部分内容会被隐藏。
 
-{{%/* /details */%}}
+{{</* /details */>}}
 ````

docs/content/docs/guide/shortcodes/steps.md

@@ -4,6 +4,8 @@ title: Steps
 
 A built-in component to display a series of steps.
 
+You can use the Markdown attribute `{class="no-step-marker"}` to prevent a heading from being counted as a step.
+
 ## Example
 
 {{% steps %}}
@@ -16,6 +18,10 @@ This is the first step.
 
 This is the second step.
 
+#### Step subheading {class="no-step-marker"}
+
+This will not be counted as a step.
+
 ### Step 3
 
 This is the third step.
@@ -43,5 +49,9 @@ This is the first step.
 
 This is the second step.
 
+#### Step subheading {class="no-step-marker"}
+
+This will not be counted as a step.
+
 {{%/* /steps */%}}
 ```

docs/content/showcase/index.fa.md

@@ -12,10 +12,17 @@ layout: wide
 </p>
 
 {{< cards >}}
+  {{< card
+        link="https://printn.dev"
+        title="PrintN"
+        image="https://raw.githubusercontent.com/printn/printn.github.io/refs/heads/main/static/images/screenshot.png"
+        imageStyle="object-fit:cover; aspect-ratio:16/9;"
+  >}}
+
   {{< card
         link="https://beginnerprivacy.com"
         title="Beginner Privacy"
-        image="https://github.com/user-attachments/assets/a72582a8-7c54-40cd-b8e3-8fd77164687c"
+        image="https://raw.githubusercontent.com/beginnerprivacy/beginnerprivacy.com/refs/heads/main/static/images/screenshot.png"
         imageStyle="object-fit:cover; aspect-ratio:16/9;"
   >}}
 

docs/content/showcase/index.ja.md

@@ -12,10 +12,17 @@ Hextra で構築されたオープンソースプロジェクト
 </p>
 
 {{< cards >}}
+  {{< card
+        link="https://printn.dev"
+        title="PrintN"
+        image="https://raw.githubusercontent.com/printn/printn.github.io/refs/heads/main/static/images/screenshot.png"
+        imageStyle="object-fit:cover; aspect-ratio:16/9;"
+  >}}
+
   {{< card
         link="https://beginnerprivacy.com"
         title="Beginner Privacy"
-        image="https://github.com/user-attachments/assets/a72582a8-7c54-40cd-b8e3-8fd77164687c"
+        image="https://raw.githubusercontent.com/beginnerprivacy/beginnerprivacy.com/refs/heads/main/static/images/screenshot.png"
         imageStyle="object-fit:cover; aspect-ratio:16/9;"
   >}}
 

docs/content/showcase/index.md

@@ -12,10 +12,17 @@ Open source projects powered by Hextra
 </p>
 
 {{< cards >}}
+  {{< card
+        link="https://printn.dev"
+        title="PrintN"
+        image="https://raw.githubusercontent.com/printn/printn.github.io/refs/heads/main/static/images/screenshot.png"
+        imageStyle="object-fit:cover; aspect-ratio:16/9;"
+  >}}
+
   {{< card
         link="https://beginnerprivacy.com"
         title="Beginner Privacy"
-        image="https://github.com/user-attachments/assets/a72582a8-7c54-40cd-b8e3-8fd77164687c"
+        image="https://raw.githubusercontent.com/beginnerprivacy/beginnerprivacy.com/refs/heads/main/static/images/screenshot.png"
         imageStyle="object-fit:cover; aspect-ratio:16/9;"
   >}}
 

docs/content/showcase/index.zh-cn.md

@@ -12,10 +12,17 @@ layout: wide
 </p>
 
 {{< cards >}}
+  {{< card
+        link="https://printn.dev"
+        title="PrintN"
+        image="https://raw.githubusercontent.com/printn/printn.github.io/refs/heads/main/static/images/screenshot.png"
+        imageStyle="object-fit:cover; aspect-ratio:16/9;"
+  >}}
+
   {{< card
         link="https://beginnerprivacy.com"
         title="Beginner Privacy"
-        image="https://github.com/user-attachments/assets/a72582a8-7c54-40cd-b8e3-8fd77164687c"
+        image="https://raw.githubusercontent.com/beginnerprivacy/beginnerprivacy.com/refs/heads/main/static/images/screenshot.png"
         imageStyle="object-fit:cover; aspect-ratio:16/9;"
   >}}
 

docs/hugo_stats.json

@@ -715,6 +715,7 @@
       "msupsub",
       "mtable",
       "mtight",
+      "no-step-marker",
       "not-prose",
       "nulldelimiter",
       "op-symbol",

layouts/_markup/render-heading.html

@@ -1,4 +1,4 @@
-<h{{ .Level }}>
+<h{{ .Level }} {{- with .Attributes.class }} class="{{ . }}" {{- end }}>
   {{- .Text | safeHTML -}}
   {{- if gt .Level 1 -}}
     <span class="hx:absolute hx:-mt-20" id="{{ .Anchor | safeURL }}"></span>

layouts/_partials/components/analytics/analytics.html

@@ -16,4 +16,9 @@
   {{ partial "components/analytics/matomo.html" . }}
 {{- end }}
 
+<!-- GoatCounter -->
+{{- if .Site.Params.analytics.goatCounter -}}
+  {{ partial "components/analytics/goat-counter.html" . }}
+{{- end -}}
+
 {{- end }}

layouts/_partials/components/analytics/goat-counter.html

@@ -0,0 +1,17 @@
+{{- with .Site.Params.analytics.goatCounter -}}
+    {{- if not .code -}}
+        {{- errorf "Missing GoatCounter 'code' configuration. See https://imfing.github.io/hextra/versions/latest/docs/guide/configuration/#goatcounter-analytics" -}}
+    {{- end -}}
+
+    <script 
+        data-goatcounter="https://{{ .code }}.goatcounter.com/count"
+        data-goatcounter-settings='
+        {
+            "no_onload":{{ .noOnload | default false }},
+            "no_events":{{ .noEvents | default false }},
+            "allow_local":{{ .allowLocal | default false }},
+            "allow_frame":{{ .allowFrame | default false }}
+        }
+        '
+        async src="//gc.zgo.at/count.js"></script>
+{{- end -}}

layouts/_partials/components/analytics/umami.html

@@ -15,7 +15,7 @@ https://umami.is/docs/tracker-configuration
 
 {{- $attributes := newScratch -}}
 
-{{- $attributes.SetInMap "umami" "src" (printf "%s/%s" .serverURL (.scriptName | default "umami.js")) -}}
+{{- $attributes.SetInMap "umami" "src" (printf "%s/%s" .serverURL (.scriptName | default "script.js")) -}}
 {{- $attributes.SetInMap "umami" "data-website-id" .websiteID -}}
 
 {{- if .hostURL -}}

layouts/_partials/end.html

@@ -0,0 +1 @@
+{{- partial "custom/end.html" -}}

layouts/_partials/sidebar.html

@@ -1,6 +1,6 @@
 {{- $context := .context -}}
 
-{{- $disableSidebar := .disableSidebar | default false -}}
+{{- $disableSidebar := .disableSidebar | default true -}}
 {{- $displayPlaceholder := .displayPlaceholder | default false -}}
 
 {{- $navRoot := cond (eq site.Home.Type "docs") site.Home $context.FirstSection -}}

layouts/_partials/toc.html

@@ -1,6 +1,6 @@
 {{/* Table of Contents */}}
 {{/* TODO: toc bottom part should be able to hide */}}
-{{- $toc := .Params.toc | default true -}}
+{{- $toc := .Params.toc | default false -}}
 {{- $onThisPage := (T "onThisPage") | default "On this page"}}
 {{- $tags := (T "tags") | default "Tags"}}
 {{- $editThisPage := (T "editThisPage") | default "Edit this page"}}

layouts/baseof.html

@@ -8,6 +8,7 @@
     {{- if or (eq .Site.Params.footer.enable nil) (.Site.Params.footer.enable) }}
       {{ partial "footer.html" . }}
     {{ end }}
+    {{ partial "end.html" .}}
     {{ partial "scripts.html" . }}
   </body>
 </html>