Link behaviour

Open external links in a new tab link

By default, Lotus Docs will open external links in a new tab.

This behaviour can be disabled by setting the extLinkNewTab parameter to false in your config:

  [params.docs]
    extLinkNewTab   = false # Open external links in a new Tab? default true
  

      params:
        docs:
            extLinkNewTab: false # Open external links in a new Tab? default true
  

  {
    "params": {
        "feedback": {
            "extLinkNewTab": false
        }
    }
}
  

External links are indicated by the ’external link’ icon to the right of the link text. e.g. Lotus Docs GitHub repository:

Preview tooltip for internal links link

When this option is enabled, internal links feature a tooltip that displays basic information about the destination page, such as it’s parent section, title, and description.

How to enable the link preview tooltip link

To enable tooltip previews for internal links, set the intLinkTooltip parameter to true in your config:

  [params.docs]
    intLinkTooltip   = true # Enable a tooltip for internal links that displays info about the destination? default false
  

      params:
        docs:
            intLinkTooltip: true # Enable a tooltip for internal links that displays info about the destination? default false
  

  {
    "params": {
        "feedback": {
            "intLinkTooltip": true
        }
    }
}
  

How to format links in your Markdown for preview tooltips link

The link preview tooltip feature works by using a custom Markdown render hook to first validate a link is internal, and then enables the tooltip function for those links. Markdown links in your content pages can be formatted in one of two ways:

1. Using the relref shortcode - This shortcode displays the relative permalink to a document¹.

   report

   Be sure to use the % delimiter if creating internal markdown links using the relref shortcode. e.g. [Plausible Analytics Guide]({{% relref "/docs/features/plausible-analytics" %}})
   warning

   Note, that relref links don’t work with _index or index files, 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/guides/

2. Links relative to the site’s root - e.g. /docs/guides/features/docsearch/ - /docs/guides/features/docsearch/

Both these formats will enable preview tooltips on internal links. However, one benefit of using relref to link internal content is that the hugo command will produce an error if an internal link’s path is invalid.