Shortcode

RelRef

返回具有给定路径、语言和输出格式的页面的相对 URL。

签名
SHORTCODE.RelRef OPTIONS
返回类型
string

用法

RelRef 方法需要单个参数:一个选项映射。

选项

path
(string)目标页面的路径。不以斜杠(/)开头的路径先相对于当前页面解析,再相对于站点的其余部分解析。
lang
(string)目标页面的语言。默认是当前语言。可选。
outputFormat
(string)目标页面的输出格式。默认是当前输出格式。可选。

示例

下面的示例展示了站点英文版本中某个页面的渲染输出:

{{ $opts := dict "path" "/books/book-1" }}
{{ .RelRef $opts }} → /en/books/book-1/

{{ $opts := dict "path" "/books/book-1" "lang" "de" }}
{{ .RelRef $opts }} → /de/books/book-1/

{{ $opts := dict "path" "/books/book-1" "lang" "de" "outputFormat" "json" }}
{{ .RelRef $opts }} → /de/books/book-1/index.json

错误处理

默认情况下,如果 Hugo 无法解析路径,它会抛出错误并让构建失败。你可以在项目配置中把它改成警告,并指定无法解析路径时要返回的 URL。

refLinksErrorLevel = 'warning'
refLinksNotFoundURL = '/some/other/url'