Links & ReferencesLink to section

This page demonstrates the various types of links and references supported by the markdown system, including internal navigation, external links, and anchor references.

Internal links navigate within the site and use client-side routing:

External links automatically open in a new tab with security attributes:

Notice the different behavior - external links have target="_blank" and rel="noopener noreferrer" added automatically.

Jump to sections within the same page:

The most common markdown link format:

[Link text](https://example.com "Optional title")

Examples:

For cleaner markdown and reusable URLs:

[Link text][reference-key]
[Another link][reference-key]


[reference-key]: https://example.com "Optional title"

Example in practice:

Check out the tmuxp documentation for more information. You can also view the tmuxp API reference.

URLs and email addresses can be automatically linked:

<https://example.com>
<[email protected]>

Results:

Links work seamlessly within list structures:

  1. First item link - Navigate home
  2. Second item link - View demos
  3. Third item link - Browse all pages
ResourceLinkDescription
DocumentationView DocsMain documentation
GitHubRepositorySource code
SupportGet HelpSupport options

Combine links with inline code:

Visual IndicatorsLink to section

Links have different visual states:

  • Normal: Standard link color
  • Hover: Color change and underline
  • Visited: Different color (in some contexts)
  • Active: While being clicked
  • Focus: Keyboard navigation highlight

Theme AdaptationLink to section

Links automatically adapt to the current theme:

  • Light mode: Blue links with darker hover
  • Dark mode: Lighter blue with appropriate contrast

Links to downloadable files:

[Download PDF](/files/document.pdf)
[Get Source Code](/downloads/source.zip)

Special protocol links:

[Call us](tel:+1234567890)
[Email support](mailto:[email protected])
[Email with subject](mailto:[email protected]?subject=Hello)

Examples:

Fragment IdentifiersLink to section

Link to specific elements:

[Go to heading](#specific-heading)
[Link with fragment](https://example.com#section)

Descriptive Link TextLink to section

❌ Bad examples:

✅ Good examples:

Provide context for screen readers:

<a href="/docs" aria-label="View tmuxp documentation">Docs</a>

Keyboard NavigationLink to section

All links are keyboard accessible:

  • Tab to navigate forward
  • Shift + Tab to navigate backward
  • Enter to activate link

Using reference-style links for cleaner markdown:

Popular projects include tmuxp, libvcs, and vcspull. These tools are part of the git-pull organization.

Security ConsiderationsLink to section

External links include security attributes:

<a href="https://external.com"
   target="_blank"
   rel="noopener noreferrer">
  External Site
</a>
  • target="_blank" - Opens in new tab
  • rel="noopener" - Prevents window.opener access
  • rel="noreferrer" - Doesn’t send referrer information

Best PracticesLink to section

  1. Use descriptive link text - Avoid generic “click here”
  2. Check link destinations - Ensure URLs are correct
  3. Consider link context - Surrounding text should make sense
  4. Test all links - Verify internal and external links work
  5. Provide alternatives - For important links, consider multiple paths
  6. Use HTTPS - Always prefer secure protocols
  7. Keep URLs stable - Avoid breaking existing links

Regular link checking ensures a good user experience:

  • Internal links: Verified during build process
  • External links: Periodic validation recommended
  • Anchor links: Test after content changes
  • Download links: Verify file availability
Return to the homepage