mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-16 07:04:39 -04:00
Fix ref
and relref
shortcode usage patterns
The documentname parameter to `ref` and `relref` shortcodes must include file extension. Including the file extension in the given usage patterns will make it much easier for users to follow.
This commit is contained in:
parent
4e7123d208
commit
000ab7c423
@ -21,12 +21,12 @@ toc: true
|
||||
## Use `ref` and `relref`
|
||||
|
||||
```
|
||||
{{</* ref "document" */>}}
|
||||
{{</* ref "document.md" */>}}
|
||||
{{</* ref "#anchor" */>}}
|
||||
{{</* ref "document#anchor" */>}}
|
||||
{{</* relref "document" */>}}
|
||||
{{</* ref "document.md#anchor" */>}}
|
||||
{{</* relref "document.md" */>}}
|
||||
{{</* relref "#anchor" */>}}
|
||||
{{</* relref "document#anchor" */>}}
|
||||
{{</* relref "document.md#anchor" */>}}
|
||||
```
|
||||
|
||||
The single parameter to `ref` is a string with a content `documentname` (e.g., `about.md`) with or without an appended in-document `anchor` (`#who`) without spaces.
|
||||
|
Loading…
x
Reference in New Issue
Block a user