Skip to content

[Feature Request]: External link indicator #1073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
theletterf opened this issue Apr 10, 2025 · 2 comments · Fixed by #1096
Closed
2 tasks done

[Feature Request]: External link indicator #1073

theletterf opened this issue Apr 10, 2025 · 2 comments · Fixed by #1096

Comments

@theletterf
Copy link
Contributor

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

When building documentation that features external links, the links should bear an external link indicator. For example:

Image

External link indicators allow users to be aware that they'll exit the docs site. Those links should open in a new tab (_blank) so as not to interrupt the navigation flow.

Proposed Solution

There are several ways of doing this that come to mind. On could be to mark external links with a special CSS class that loads an SVG in the ::after of the link. We might also want to allowlist a set of domains to point out that they are, in fact, Elastic web properties, treating them as internal links.

Examples and Research

Most SSGs for docs have this or are discussing this. Example: squidfunk/mkdocs-material#3595

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Important

@theletterf
Copy link
Contributor Author

+CC @bmorelli25 @alaudazzi

@bmorelli25
Copy link
Member

Those links should open in a new tab (_blank) so as not to interrupt the navigation flow.

This part we've already implemented in #793

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants