hugo-book
Code Issues

Add option to configure portable links behaviour: off, error or warning

Browse Source
This commit is contained in:
Alex Shpak
2025-09-27 00:05:41 +02:00
parent 7960aa3672
commit 6a134d4fe9
4 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
exampleSite/hugo.toml
+3 -2
View File
@@ -136,8 +136,9 @@ enableGitInfo = true
# /!\ This is an experimental feature, might be removed or changed at any time # /!\ This is an experimental feature, might be removed or changed at any time
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages. # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
# Theme will print warning if page referenced in markdown does not exists. # Theme will print warning or error if page referenced in markdown does not exists.
BookPortableLinks = true # Possible values are false | 'warning' | 'error'
BookPortableLinks = 'warning'
# /!\ This is an experimental feature, might be removed or changed at any time # /!\ This is an experimental feature, might be removed or changed at any time
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
exampleSite/hugo.yaml
+3 -2
View File
@@ -120,8 +120,9 @@ params:
# /!\ This is an experimental feature, might be removed or changed at any time # /!\ This is an experimental feature, might be removed or changed at any time
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages. # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
# Theme will print warning if page referenced in markdown does not exists. # Theme will print warning or error if page referenced in markdown does not exists.
BookPortableLinks: true # Possible values are false | 'warning' | 'error'
BookPortableLinks: 'warning'
# /!\ This is an experimental feature, might be removed or changed at any time # /!\ This is an experimental feature, might be removed or changed at any time
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
layouts/_partials/docs/links/portable-image.html
+7 -1
View File
@@ -13,7 +13,13 @@
{{- else with (resources.Get $path) -}} {{- else with (resources.Get $path) -}}
{{- $destination = .RelPermalink -}} {{- $destination = .RelPermalink -}}
{{- else -}} {{- else -}}
{{- warnf "Image reference '%s' not found in '%s'" .Destination .Page.Permalink -}} {{- $mode := .Page.Site.Params.BookPortableLinks -}}
{{- $message := printf "Image reference '%s' not found in '%s'" .Destination .Page.RelPermalink -}}
{{- if eq $mode "warning" -}}
{{- warnf $message -}}
{{- else if eq $mode "error" -}}
{{- errorf $message -}}
{{- end -}}
{{- end -}} {{- end -}}
{{- with $url.RawQuery -}} {{- with $url.RawQuery -}}
layouts/_partials/docs/links/portable-link.html
+7 -1
View File
@@ -16,7 +16,13 @@
{{- else with (resources.Get $path) -}} {{- else with (resources.Get $path) -}}
{{- $destination = .RelPermalink -}} {{- $destination = .RelPermalink -}}
{{- else -}} {{- else -}}
{{- warnf "Reference '%s' not found in '%s'" .Destination .Page.RelPermalink -}} {{- $mode := .Page.Site.Params.BookPortableLinks -}}
{{- $message := printf "Image reference '%s' not found in '%s'" .Destination .Page.RelPermalink -}}
{{- if eq $mode "warning" -}}
{{- warnf $message -}}
{{- else if eq $mode "error" -}}
{{- errorf $message -}}
{{- end -}}
{{- end -}} {{- end -}}
{{- with $url.RawQuery -}} {{- with $url.RawQuery -}}