External Links
To add external links to the navigation, add them to the nav_external_links
configuration option.
External links will appear in the navigation after the links to ordinary pages.
Example: external links
site:
# External navigation links
nav_external_links:
- title: wmk on GitHub
url: https://github.com/bk/wmk
hide_icon: false # set to true to hide the external link icon - defaults to false
opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false
The external links are decorated by an icon, which distinguishes them from internal links.
You can suppress the icon by setting hide_icon: true
.
By default, external links are not opened in a new tab. However, this can be enabled by:
- setting
opens_in_new_tab: true
in the link's configuration object - setting the configuration option
site.nav_external_links_new_tab: true
.
When they conflict, opens_in_new_tab
takes precedence.