diff options
author | Mitch Grogg <mitchellgrogg@gmail.com> | 2020-12-12 06:06:14 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-12 06:06:14 +0300 |
commit | 2b63336120c0a4f8290e04789e102cb1646ea2ad (patch) | |
tree | 5a15d05b44a3288d160c229fd382f999c30de89e /userguide/content | |
parent | 5d264bf5324fa962cdbce118baeb3b24bf457848 (diff) |
Update the Hugo ref shortcode example to be surrounded by two curly braces.
Diffstat (limited to 'userguide/content')
-rw-r--r-- | userguide/content/en/docs/Best practices/site-guidance.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/userguide/content/en/docs/Best practices/site-guidance.md b/userguide/content/en/docs/Best practices/site-guidance.md index 16ebc5e..a5e8dd9 100644 --- a/userguide/content/en/docs/Best practices/site-guidance.md +++ b/userguide/content/en/docs/Best practices/site-guidance.md @@ -33,7 +33,7 @@ configuring your local editor to use 4 spaces when the **Tab** key is pressed. ## Linking -By default, regular relative URLs in links are left unchanged by Hugo (they're still relative links in your site's generated HTML), hence some hardcoded relative links like `[relative cross-link](../../peer-folder/sub-file.md)` might behave unexpectedly compared to how they work on your local file system. You may find it helpful to use some of Hugo's built-in [link shortcodes](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) to avoid broken links in your generated site. For example a `{< ref "filename.md" >}` link in Hugo will actually +By default, regular relative URLs in links are left unchanged by Hugo (they're still relative links in your site's generated HTML), hence some hardcoded relative links like `[relative cross-link](../../peer-folder/sub-file.md)` might behave unexpectedly compared to how they work on your local file system. You may find it helpful to use some of Hugo's built-in [link shortcodes](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) to avoid broken links in your generated site. For example a `{{< ref "filename.md" >}}` link in Hugo will actually find and automatically link to your file named `filename.md`. Note, however, that `ref` and `relref` links don't work with `_index` or `index` files (for example, this site's [content landing page](/docs/adding-content/)): you'll need to use regular Markdown links to section landing or other index pages. Specify these links relative to the site's root URL, for example: `/docs/adding-content/`. |