Hugo 0.45: Revival of ref, relref and GetPage
Hugo 0.45
is the revival of ref, relref and GetPage. @vassudanagunta and @bep have done some great work improving the API and implementation for the helper functions used to get one page. Before this release, the API was a little bit clumsy and the result potentially ambiguous in some situations.
Now you can simply do:
{{ with .Site.GetPage "/blog/my-post.md" }}{{ .Title }}{{ end }}
Or to get a section page:
{{ with .Site.GetPage "/blog" }}{{ .Title }}{{ end }}
We have also added a .GetPage
method on Page
and added support for page-relative linking. This means that the leading slash (/
) now has a meaning. For .Site.GetPage
, all lookups will start at the content root. But for lookups with a Page
context, paths without a leading slash will be treated as relative to the page.
This means that the following example will find the page in the current section:
{{< ref "my-post.md" >}}
You can also use the ..
to refer to a page one level up etc.:
{{< ref "../my-post.md" >}}
We have now also added language support to ref
and relref
, so you can link to a page in another language:
{{< relref path="document.md" lang="ja" >}}
To link to a given Output Format of a document, you can use this syntax:
{{< relref path="document.md" outputFormat="rss" >}}
To make working with these reflinks on bigger sites easier to work with, we have also improved the error logging, and added two new configuration settings:
- refLinksErrorLevel: ERROR (default, will fail the build when a reflink cannot be resolved) or WARNING.
- refLinksNotFoundURL: Set this to an URL placeholder used when no reference could be resolved.
Visit the Hugo Docs for more information.
We have also done some important improvements and fixes in Hugo Pipes in this release: SCSS source maps on Windows now works, we now support project-local PostCSS
installation, and we have added IncludePaths
to SCSS
options, making it possible to include, say, a path below node_modules
in the SASS/SCSS build.
This release represents 31 contributions by 4 contributors to the main Hugo code base. @bep leads the Hugo development with a significant amount of contributions, but also a big shoutout to @vassudanagunta, @hairmare, and @garrmcnu for their ongoing contributions. And a big thanks to @digitalcraftsman for his relentless work on keeping the themes site in pristine condition and to @kaushalmodi for his great work on the documentation site.
Many have also been busy writing and fixing the documentation in hugoDocs, which has received 10 contributions by 8 contributors. A special thanks to @kaushalmodi, @Hanzei, @KurtTrowbridge, and @regisphilibert for their work on the documentation site.
Hugo now has:
- 27334+ stars
- 443+ contributors
- 238+ themes
Notes
.Site.GetPage
with more than 2 arguments will not work anymore. This means that{{ .Site.GetPage "page" "blog" "my-post.md" }}
will fail.{{ .Site.GetPage "page" "blog/my-post.md" }}
will work, but we recommend you use the simpler{{ .Site.GetPage "/blog/my-post.md" }}
- Relative paths in
relref
orref
that finds its match not relative to the page itself will work, but we now print a warning saying that you should correct it to an absolute path. E.g.{{< ref "blog/my-post.md" >}}
=>{{< ref "/blog/my-post.md" >}}
.
Enhancements
- Print a WARNING about relative non-relative ref/relref matches a451c49f @bep #4973
- Allow untyped nil to be merged in lang.Merge ff16c42e @bep #4977
- Get rid of the utils package 062510cf @bep
- Update hugo_windows.go 4e1d0cd9 @bep
- Add IncludePaths config option 166483fe @bep #4921
- Increase refLinker test coverage 8278384b @vassudanagunta
- Add test coverage for recent ref overhaul 2bac3715 @vassudanagunta #4969
- Update ref, relref, GetPage docs 1eb8b36b @bep
- Document refLinksErrorLevel and refLinksNotFoundURL 00c74ee7 @bep #4964
- Add configurable ref/relref error handling and notFoundURL e25aa655 @bep #4964
- Try node_modules/postcss-cli/bin/postcss first ebe4d39f @bep #4952
- Add optional lang as argument to rel/relref d741064b @bep #4956
- Simplify .Site.GetPage etc. 3eb313fe @bep #4147#4727#4728#4728#4726#4652
- Unify page lookups b93417aa @vassudanagunta #4147#4727#4728#4728#4726#4652
- Improve error message 4c240800 @bep
- Remove unused code 2f2bc7ff @bep
Fixes
- Avoid server panic on TOML mistake in i18n 75acff5f @bep #4942
- Only set ‘allThemes’ if there are themes in the config file 38204c4a @garrmcnu #4851
- Fix potential server panic with drafts/future enabled 1ab4658c @bep #4965
- Mark shortcode changes as content changes in server mode 12679b40 @bep #4965
- Fix source maps on Windows f01505c9 @bep #4968
- Fix typo-logic bug in GetPage b56d9a12 @vassudanagunta
- Enable test case fixed by commit 501543d4 d6fde8fa @vassudanagunta
- Fix theme config for Work Fs 5c9d5413 @bep #4951
- Fix addkit link to account for i18n fd1f4a78 @hairmare
Улучшить эту страницу