Skip to content
Kevin Rue-Albrecht edited this page Jul 5, 2022 · 7 revisions

Internal links

Cross-references within pages of this documentation can be formatted as follows:

[Link text]({{< relref "page#anchor" >}})

Specifically:

  • The value Link text is usually set to the title of the target page
  • The value page#anchor given to the relref function is usually the path to a page, optionally followed by an anchor to a header in that page (e.g., /docs/linux/introduction#what-is-bash).

See https://gohugo.io/functions/relref/ for more information.

External links

Links to external website (i.e., any web page that is not part of this documentation) are formatted as follows:

[Link text →][link-definition]

[link-definition]: url#anchor

Specifically:

  • The arrow symbol is added as a visual cue of the external link. The arrow has no programmatical meaning for the link, it is purely a visual addition to the link text.
  • The link text is usually set to the title of the web page at that URL.
  • The URL is typically the https or http address taken from the web browser. The URL may include anchors to directly point to the relevant header in the target web page, where applicable.
  • Link definitions are grouped together at the bottom of each Markdown file.

Clone this wiki locally