Fixes after review

- `where` > `location` - Edit link > in a partial
imfing · Apr 2, 2024 · f87f19f · f87f19f
1 parent 795755b
commit f87f19f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 34 deletions.
diff --git a/exampleSite/hugo.yaml b/exampleSite/hugo.yaml
@@ -142,7 +142,7 @@ params:
 
   editURL:
     enable: true
-    where: "single" # single | toc
+    location: "toc" # single | toc
     base: "https://github.com/imfing/hextra/edit/main/exampleSite/content"
 
   blog:

diff --git a/layouts/partials/components/edit-url.html b/layouts/partials/components/edit-url.html
@@ -0,0 +1,22 @@
+{{- $context := .context -}}
+{{- $editThisPage := (T "editThisPage") | default "Edit this page"}}
+{{- $linkClass := "mb-4 block text-xs text-gray-500 ltr:text-right rtl:text-left dark:text-gray-400" -}}
+{{- if and (site.Params.editURL.enable) (eq site.Params.editURL.location .source) -}}
+  {{- $editURL := site.Params.editURL.base | default "" -}}
+  {{- with .Params.editURL -}}
+    {{/* if `editURL` is set in the front matter */}}
+    {{- $editURL = . -}}
+  {{- else -}}
+    {{- with $context.File -}}
+      {{/* `.FileInfo.Meta.SourceRoot` is a Hugo internal field, e.g. `/path/to/repo/content/en/` */}}
+      {{- $sourceDir := replace (strings.TrimPrefix .FileInfo.Meta.BaseDir .FileInfo.Meta.SourceRoot) "\\" "/" -}}
+      {{- $sourceDir = strings.TrimPrefix "/content" $sourceDir -}}
+      {{- $path := replace .Path "\\" "/" -}}
+      {{- $editURL = urls.JoinPath $editURL $sourceDir $path -}}
+    {{- end -}}
+  {{- end -}}
+  {{- if eq site.Params.editURL.location "toc" -}}
+    {{- $linkClass = "hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50" -}}
+  {{- end -}}
+  <a class="{{ $linkClass }}" href="{{ $editURL }}" target="_blank" rel="noreferer">{{ $editThisPage }}</a>
+{{- end -}}
diff --git a/layouts/partials/components/last-updated.html b/layouts/partials/components/last-updated.html
@@ -2,23 +2,8 @@
 {{- $editThisPage := (T "editThisPage") | default "Edit this page"}}
 
 {{- if site.Params.displayUpdatedDate -}}
-  <div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">
-  {{- if and (site.Params.editURL.enable) (eq site.Params.editURL.where "single") -}}
-    {{- $editURL := site.Params.editURL.base | default "" -}}
-    {{- with .Params.editURL -}}
-      {{/* if `editURL` is set in the front matter */}}
-      {{- $editURL = . -}}
-    {{- else -}}
-      {{- with .File -}}
-        {{/* `.FileInfo.Meta.SourceRoot` is a Hugo internal field, e.g. `/path/to/repo/content/en/` */}}
-        {{- $sourceDir := replace (strings.TrimPrefix .FileInfo.Meta.BaseDir .FileInfo.Meta.SourceRoot) "\\" "/" -}}
-        {{- $sourceDir = strings.TrimPrefix "/content" $sourceDir -}}
-        {{- $path := replace .Path "\\" "/" -}}
-        {{- $editURL = urls.JoinPath $editURL $sourceDir $path -}}
-      {{- end -}}
-    {{- end -}}
-    <a class="mb-4 block text-xs text-gray-500 ltr:text-right rtl:text-left dark:text-gray-400" href="{{ $editURL }}" target="_blank" rel="noreferer">{{ $editThisPage }}</a>
-  {{- end -}}
+<div class="hx-mt-12 hx-mb-8 hx-block hx-text-xs hx-text-gray-500 ltr:hx-text-right rtl:hx-text-left dark:hx-text-gray-400">
+{{ partial "components/edit-url.html" (dict "source" "single" "context" .) }}
   {{- with .Lastmod -}}
     {{ $datetime := (time.Format "2006-01-02T15:04:05.000Z" .) }}
     <div class="hx-mt-4">{{ $lastUpdated }} <time datetime="{{ $datetime }}">{{ partial "utils/format-date" . }}</time></div>

diff --git a/layouts/partials/toc.html b/layouts/partials/toc.html
@@ -24,22 +24,7 @@
 
       {{/* TOC bottom part */}}
       <div class="{{ $borderClass }} hx-sticky hx-bottom-0 hx-flex hx-flex-col hx-items-start hx-gap-2 hx-pb-8 dark:hx-border-neutral-800 contrast-more:hx-border-t contrast-more:hx-border-neutral-400 contrast-more:hx-shadow-none contrast-more:dark:hx-border-neutral-400">
-        {{- if and (site.Params.editURL.enable) (eq site.Params.editURL.where "toc") -}}
-          {{- $editURL := site.Params.editURL.base | default "" -}}
-          {{- with .Params.editURL -}}
-            {{/* if `editURL` is set in the front matter */}}
-            {{- $editURL = . -}}
-          {{- else -}}
-            {{- with .File -}}
-              {{/* `.FileInfo.Meta.SourceRoot` is a Hugo internal field, e.g. `/path/to/repo/content/en/` */}}
-              {{- $sourceDir := replace (strings.TrimPrefix .FileInfo.Meta.BaseDir .FileInfo.Meta.SourceRoot) "\\" "/" -}}
-              {{- $sourceDir = strings.TrimPrefix "/content" $sourceDir -}}
-              {{- $path := replace .Path "\\" "/" -}}
-              {{- $editURL = urls.JoinPath $editURL $sourceDir $path -}}
-            {{- end -}}
-          {{- end -}}
-          <a class="hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50" href="{{ $editURL }}" target="_blank" rel="noreferer">{{ $editThisPage }}</a>
-        {{- end -}}
+      {{ partial "components/edit-url.html" (dict "source" "toc" "context" .) }}
         {{/* Scroll To Top */}}
         <button aria-hidden="true" id="backToTop" onClick="scrollUp();" class="hx-transition-all hx-duration-75 hx-opacity-0 hx-text-xs hx-font-medium hx-text-gray-500 hover:hx-text-gray-900 dark:hx-text-gray-400 dark:hover:hx-text-gray-100 contrast-more:hx-text-gray-800 contrast-more:dark:hx-text-gray-50">
           <span>