steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-04 03:01:23 -06:00
Code Issues Packages Projects Releases Wiki Activity
just-the-docs/docs/navigation/main/external.md
Peter Mosses dd0b814bfd
Docs: Allow unlimited multi-level navigation (#1440) 
* Remove `jekyll-default-layout` plugin

* Move docs/navigation-structure to docs/navigation

* Fix uses of line-nos in md files

* Update CHANGELOG.md

---------

Co-authored-by: Matt Wang <matt@matthewwang.me>
2024-08-20 22:50:47 +02:00

1.2 KiB
Raw Blame History

title parent nav_order
External Links Main Navigation 6

External Links

To add external links to the navigation, add them to the nav_external_links [configuration]({% link docs/configuration.md %}) option in your site's _config.yml file. External links will appear in the navigation after the links to ordinary pages, but before any collections.

Example

# External navigation links
nav_external_links:
  - title: Just the Docs on GitHub
    url: https://github.com/just-the-docs/just-the-docs
    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

Opening external links in a new tab

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:

  1. setting opens_in_new_tab: true in the link's configuration object
  2. setting the configuration option nav_external_links_new_tab: true in _config.yml

When they conflict, opens_in_new_tab takes precedence.