fix(v2): classify link hrefs with protocol identifier as internal

[ghost]

Motivation

Currently, only specific protocol links (http://, https://, tel: and mailto:) in the navbar and footer are treated as external - other protocols such as ssh://, sftp:// etc are treated as internal and get prepended with baseUrl which breaks the links.

It would be nice to be able to have other protocols in links as well. My suggested solution is to let the isInternalUrl test check for any protocol identifier rather than specific ones.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Using the following navbar configuration in docusaurus.config.js

    navbar: {
      hideOnScroll: true,
      title: 'Docusaurus',
      logo: {
        alt: 'Docusaurus Logo',
        src: 'img/docusaurus.svg',
        srcDark: 'img/docusaurus_keytar.svg',
      },
      links: [
        {
          href: 'https://example.com',
          label: 'https://example.com',
          position: 'left',
        },
        {
          href: 'tel:18005551042',
          label: 'tel:18005551042',
          position: 'left',
        },
        {
          href: 'mailto:user@example.com',
          label: 'mailto:user@example.com',
          position: 'left',
        },
        {
          href: 'ssh://host.example.com',
          label: 'ssh://host.example.com',
          position: 'left',
        },
        {
          to: 'versions',
          label: `v${versions[0]}`,
          position: 'right',
        },
        {
          href: 'https://github.com/facebook/docusaurus',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub repository',
        },
      ],
    }

Current behavior

The concerned navbar items are output as:

<li class="menu__list-item"><a href="https://example.com/" target="_blank" rel="noopener noreferrer" class="menu__link">https://example.com</a></li>
<li class="menu__list-item"><a href="tel:18005551042" target="_blank" rel="noopener noreferrer" class="menu__link">tel:18005551042</a></li>
<li class="menu__list-item"><a href="mailto:user@example.com" target="_blank" rel="noopener noreferrer" class="menu__link">mailto:user@example.com</a></li>
<li class="menu__list-item"><a target="_blank" rel="noopener noreferrer" href="http://localhost:3000/ssh://host.example.com" class="menu__link">ssh://host.example.com</a></li>

with http://localhost:3000/ prepended to the href property on the last link.

Behavior after the change

Navbar items are output as:

<li class="menu__list-item"><a href="https://example.com/" target="_blank" rel="noopener noreferrer" class="menu__link">https://example.com</a></li>
<li class="menu__list-item"><a href="tel:18005551042" target="_blank" rel="noopener noreferrer" class="menu__link">tel:18005551042</a></li>
<li class="menu__list-item"><a href="mailto:user@example.com" target="_blank" rel="noopener noreferrer" class="menu__link">mailto:user@example.com</a></li>
<li class="menu__list-item"><a href="ssh://host.example.com/" target="_blank" rel="noopener noreferrer" class="menu__link">ssh://host.example.com</a></li>

and all links are working as expected.

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

[facebook-github-bot]

Hi @svtfrida!

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[docusaurus-bot]

Deploy preview for docusaurus-2 ready!

Built with commit 0934ca5

https://deploy-preview-3063--docusaurus-2.netlify.app

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[slorber]

agree, + it does not break existing tests so it looks like a safe change to me, thanks!