Merge pull request #431 from gethinode/relref

Refactor link shortcode

exampleSite/content/en/blog/bootstrap-elements.md

@@ -217,6 +217,31 @@ As an example, the following shortcode displays an image with rounded corners an
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->
 
+## Link
+
+As an example, the following shortcodes render links in different formats.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+
+- {{</* link hinode >}}Named link with default settings{{< /link */>}}
+- {{</* link name=hinode cue=false tab=false >}}Named link opening in current tab w/o icon{{< /link */>}}
+- {{</* link name=hinode cue=true tab=true >}}Named link opening in new tab with icon{{< /link */>}}
+- {{</* link hinode /*/>}}
+- {{</* link href="https://developer.mozilla.org" >}}External link{{< /link */>}}
+- {{</* link "./projects/another-project" >}}Internal link with title{{< /link */>}}
+- {{</* link url="projects/another-project" /*/>}}
+- {{</* link url="/projects/another-project" /*/>}}
+- {{</* link url="../projects/another-project" case=false /*/>}}
+- {{</* link "/about/" /*/>}}
+- {{</* link "/fr/about/" /*/>}}
+- {{</* link "/fr/about" >}}About (French){{< /link */>}}
+- {{</* link "#image" /*/>}}
+- {{</* link "components/#map" /*/>}}
+
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Nav
 
 As an example, the following shortcode displays a tab group with vertically aligned pills.

exampleSite/hugo_stats.json

@@ -433,6 +433,7 @@
       "icon",
       "image",
       "leaflet-map-0",
+      "link",
       "map",
       "nav",
       "nav-0",

hugo_stats.json

@@ -149,8 +149,6 @@
       "py-2",
       "py-5",
       "py-md-1",
-      "ratio",
-      "ratio-16x9",
       "rounded",
       "row",
       "row-cols-1",

layouts/partials/utilities/link.html

@@ -38,7 +38,21 @@
             {{- $anchor = index $segments 1 -}}            
         {{ end }}
     {{ end }}
+    {{- $destination = strings.TrimSuffix "/" $destination -}}
     {{- $ref := $page.GetPage $destination -}}
+
+    {{- if not $ref }}
+        {{- $segments := split $destination "/" -}}
+        {{- if and (hasPrefix $destination "/")  (gt (len $segments) 1) -}}
+            {{- $prefix := index $segments 1 -}}
+            {{- $page := .Page -}}
+            {{ with index (where site.Sites "Language.Lang" $prefix) 0 }}
+                {{- $path := printf "/%s" (strings.TrimPrefix (printf "/%s/" $prefix) $destination) }}
+                {{- $ref = .GetPage $path -}}
+            {{ end }}
+        {{- end -}}
+    {{- end -}}
+
     {{- if not $ref -}}
         {{- errorf "partial [utilities/link.html] - Cannot find page: %s" $destination -}}
     {{- else -}}

layouts/shortcodes/accordion-item.html

@@ -50,6 +50,6 @@
     </h2>
     {{- end -}}
     <div id="{{ $parent }}-item-{{ $id }}" class="accordion-collapse collapse{{ if $show }} show{{ end }}{{ with $class }} {{ . }}{{ end }}" aria-labelledby="{{ $parent }}-heading-{{ $id }}" data-bs-parent="#{{ $parent }}">
-        <div class="accordion-body">{{ $body | markdownify | safeHTML }}</div>
+        <div class="accordion-body">{{ $body | .Page.RenderString | safeHTML }}</div>
     </div>
 </div>

layouts/shortcodes/accordion.html

@@ -26,7 +26,7 @@
 {{- $body := .Inner -}}
 {{- if $open -}}
     {{- $pattern := printf "data-bs-parent=\"#%s\"" $id -}}
-    {{- $body = (replace .Inner $pattern "") | markdownify | safeHTML }}
+    {{- $body = (replace .Inner $pattern "") | .Page.RenderString | safeHTML }}
 {{- end -}}
 
 <div id="{{ $id }}" class="accordion mb-3{{ with $class }} {{ . }}{{ end }}">

layouts/shortcodes/alert.html

@@ -55,7 +55,7 @@
     <div class="d-flex alert alert-{{ $color }} {{ if $dismissible }}alert-dismissible fade show{{ end }}{{ with $class }} {{ . }}{{ end }}" role="alert">
         {{ with $icon }}<div class="pt-1 pe-2">{{ . }}</div>{{ end }}
         <div class="flex-grow-1 my-auto">
-            {{ trim .Inner " \r\n" | markdownify | safeHTML -}}
+            {{ trim .Inner " \r\n" | .Page.RenderString | safeHTML -}}
             {{ if $dismissible }}<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>{{ end }}
         </div>
     </div>

layouts/shortcodes/link.html

@@ -4,10 +4,11 @@
     named link or internal reference (in that order). Any inner text is rendered as the link title, otherwise it uses
     the host name (for external links), link title (for internal links), or anchor name (for any local references
     containing a `#`). The shortcode supports the following named arguments:
-    "name"          Optional name of the link maintained in the "links" section of the site's parameters. If omitted,
+    "href"          Required reference to either an external link (if it starts with http), a named link (if it can be
-                    the "url" argument should be provided instead.
+                    found in params.links), or internal reference. External and internal references may include an
-    "url"           Optional url of the link, including the scheme ("http" or "https"). If omitted, the "name" argument
+                    anchor "#".
-                    should be provided instead.
+    "name"          Alias of href.
+    "url"           Alias of href.
     "cue"           Optional flag to indicate if an external link should show a visual cue, defaults to setting
                     "main.externalLinks.cue" in the site's parameters.
     "tab"           Optional flag to indicate if an external link should open in a new tab, defaults to setting
@@ -18,58 +19,82 @@
 -->
 
 {{- $error := false -}}
+{{ $href := "" }}
 {{ $name := "" }}
 {{ $url := "" }}
+{{ $class := "" }}
 {{ $case := true }}
 {{ $cue := site.Params.main.externalLinks.cue }}
 {{ $tab := site.Params.main.externalLinks.tab }}
-{{ $text := trim .Inner " \r\n" | markdownify | safeHTML }}
+{{ $text := trim .Inner " \r\n" | .Page.RenderString | safeHTML }}
 {{- $anchor := "" -}}
 
 {{ if .IsNamedParams }}
+    {{ $href = .Get "href" }}
     {{ $name = .Get "name" }}
     {{ $url = .Get "url" }}
     {{ $cue = .Get "cue" | default site.Params.main.externalLinks.cue }}
     {{ $tab = .Get "tab" | default site.Params.main.externalLinks.tab }}
     {{ $case = .Get "case" | default true }}
-{{ else if strings.Contains (.Get 0) "/" }}
+    {{- $class := .Get "class" -}}
-    {{ $url = .Get 0 }}
 {{ else }}
-    {{ $name = .Get 0 }}
+    {{ $href = .Get 0 }}
 {{ end }}
 
-{{ if not (or $name $url) }}
+{{- $href = or (or $href $name) $url -}}
-    {{ errorf "Expected param 'name' or 'url': %s" .Position -}}
+{{ if not $href }}
+    {{ errorf "Expected param 'href': %s" .Position -}}
     {{ $error = true -}}
 {{ end }}
 
-{{ if $name }}
+{{- if hasPrefix $href "http" -}}
-    {{ $url = index site.Params.links $name }}
+    {{ $url = $href }}
-    {{ if not $url }}
+{{- else if not (strings.Contains $href "/") -}}
-        {{ $url = $name }}
+    {{ $url = index site.Params.links $href }}
-        {{- if strings.Contains $url "#" }}
+{{- end -}}
-            {{ $segments := split $url "#" }}
+
-            {{- if ne (len $segments) 2 }}
+{{ if not $url }}
-                {{ errorf "Malformed path, expected one anchor '#' only: '%s' at %s" $url .Position -}}
+    {{- $href = strings.TrimPrefix "./" $href -}}
-            {{ else }}
+    {{- if strings.Contains $href "#" }}
-                {{- $url = index $segments 0 -}}            
+        {{ $segments := split $href "#" }}
-                {{- $anchor = index $segments 1 -}}            
+        {{- if ne (len $segments) 2 }}
-                {{ if not $url }}
+            {{ errorf "Malformed path, expected one anchor '#' only: '%s' at %s" $href .Position -}}
-                    {{- $url = strings.TrimSuffix "/" .Page.RelPermalink -}}
+        {{ else }}
-                    {{- with .Page.Language }}{{ $url = strings.TrimPrefix (path.Join "/" .Lang) $url}}{{ end -}}
+            {{- $url = index $segments 0 -}}            
-                {{ end }}
+            {{- $anchor = index $segments 1 -}}            
+            {{ if not $url }}
+                {{- $url = strings.TrimSuffix "/" .Page.RelPermalink -}}
+                {{- with .Page.Language }}{{ $url = strings.TrimPrefix (path.Join "/" .Lang) $url}}{{ end -}}
             {{ end }}
         {{ end }}
+    {{ else }}
+        {{- $url = $href -}}
     {{ end }}
 {{ end }}
 
-{{- $class := .Get "class" -}}
-
 {{- $isExternal := ne (urls.Parse (absURL $url)).Host (urls.Parse site.BaseURL).Host -}}
 {{- if not $isExternal -}}
-    {{- $ref := .Page.GetPage $url -}}
+    {{- $url = strings.TrimSuffix "/" $url -}}
+
+    {{- $ref := "" -}}
     {{- if not $ref -}}
-        {{- errorf "Cannot find page: '%s' at %s" $url .Position -}}
+        {{- $ref = .Page.GetPage $url -}}
+    {{- end -}}
+
+    {{- if not $ref }}
+        {{- $segments := split $url "/" -}}
+        {{- if and (hasPrefix $url "/")  (gt (len $segments) 1) -}}
+            {{- $prefix := index $segments 1 -}}
+            {{- $page := .Page -}}
+            {{ with index (where site.Sites "Language.Lang" $prefix) 0 }}
+                {{- $path := printf "/%s" (strings.TrimPrefix (printf "/%s/" $prefix) $url) }}
+                {{- $ref = .GetPage $path -}}
+            {{ end }}
+        {{- end -}}
+    {{- end -}}
+
+    {{- if not $ref -}}
+        {{- errorf "Cannot find page: '%s' at %s" $href .Position -}}
         {{- $error = true -}}
     {{- end -}}
 {{- end -}}
@@ -81,3 +106,5 @@
     {{ partial "utilities/link.html" (dict "destination" $url "text" $text "cue" $cue "tab" $tab "case" $case "class" $class "page" .Page) }}
 {{- end -}}
 
+
+

layouts/shortcodes/nav-item.html

@@ -50,5 +50,5 @@
 <div class="tab-pane{{ if $show }} active {{ if $fade}}show{{ end }}{{ end }} {{ if $fade}}fade{{ end }}" id="{{ $parent }}-{{ $id }}" 
     role="tabpanel" aria-labelledby="{{ $parent }}-btn-{{ $id }}" tabindex="0" data-header="{{ $header }}" {{ if $show }}data-show-id="{{ $id }}"{{ end }} 
     data-has-content="{{ gt (len $body) 0 }}" {{ if $disabled }} data-disabled-id="{{ $id }}"{{ end }}>
-    {{ $body | markdownify | safeHTML }}
+    {{ $body | .Page.RenderString | safeHTML }}
 </div>

layouts/shortcodes/table.html

@@ -8,7 +8,7 @@
     {{ $responsive = (slice "table-responsive") -}}
 {{- end -}}
 
-{{- $input := .Inner | markdownify }}
+{{- $input := .Inner | .Page.RenderString }}
 {{- $input = replace $input "style=\"text-align:left\"" "class=\"text-start\"" -}}
 {{- $input = replace $input "style=\"text-align:center\"" "class=\"text-center\"" -}}
 {{- $input = replace $input "style=\"text-align:right\"" "class=\"text-end\"" -}}

layouts/shortcodes/timeline.html

@@ -79,7 +79,7 @@
                     {{ $datestr := (partial "utilities/date.html" (dict "date" $date "format" "long")) -}}
                     <p class="mb-0"><small class="text-body-secondary text-uppercase">{{ $datestr -}}</small></p>
                 {{ end }}
-                <p class="mt-3 mb-0">{{ $content | markdownify }}</p>
+                <p class="mt-3 mb-0">{{ $content | .Page.RenderString }}</p>
             </div>
         </div>
     </div>    

layouts/tags/list.html

@@ -13,7 +13,7 @@
                                 {{ .Count }} {{ if gt .Count 1 }} {{ T "articles" }} {{ else }} {{ T "article" }} {{ end }}
                             </div>
                             <div class="col">
-                                <a href="{{ (path.Join .Page.RelPermalink) | relLangURL }}">{{ .Name | markdownify }}</a>
+                                <a href="{{ (path.Join .Page.RelPermalink) | relLangURL }}">{{ .Name | .Page.RenderString }}</a>
                             </div>
                         </div>
                     {{ end }}
@@ -34,7 +34,7 @@
                                     <p class="text-body-secondary mt-5">{{ $year }}</p>
                                     {{ $.Scratch.Set "lastYear" $year }}
                                 {{ end }}
-                                <a href="{{ (path.Join .Page.RelPermalink) | relLangURL }}">{{ if .Draft }}{{ T "draft" | upper }}: {{end}}{{ .Title | markdownify }}</a>
+                                <a href="{{ (path.Join .Page.RelPermalink) | relLangURL }}">{{ if .Draft }}{{ T "draft" | upper }}: {{end}}{{ .Title | .Page.RenderString }}</a>
                             </div>
                         </div>
                     {{ end }}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.18.3",
+      "version": "0.18.4",
       "license": "MIT",
       "devDependencies": {
         "@fullhuman/postcss-purgecss": "^5.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",