Links & References
On this page
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:
- Home page - Link to the root
- Demo hub - Relative link to another page
- Contributing guide - Another internal page
- This very page - Self-reference
External links open in the same tab, like every link on the site; Back returns here:
- GitHub - Simple external link
- Anthropic - Company website
- MDN Web Docs - Developer resources
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>Results:
Links work seamlessly within list structures:
- First item link - Navigate home
- Second item link - View demos
- Nested link - Typography showcase
- Another nested - Tables demo
- Third item link - Browse all pages
| Resource | Link | Description |
|---|---|---|
| Documentation | View Docs | Main documentation |
| GitHub | Repository | Source code |
| Support | Get Help | Support options |
Combine links with inline code:
- Install via
npm install tmuxp - View the
config.jsonfile - Read about
Array.prototype.map()
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
Links take the current palette’s ink (--theme-ink), a step of its hue that keeps 4.5:1 contrast on the page in light
and dark mode.
Links to downloadable files:
[Download PDF](/files/document.pdf)[Get Source Code](/downloads/source.zip)Special protocol links:
[Call us](tel:+1234567890)Examples:
Link to specific elements:
[Go to heading](#specific-heading)[Link with fragment](https://example.com#section)❌ Bad examples:
- Click here for more information
- Read more here
- Link
✅ Good examples:
Provide context for screen readers:
<a href="/docs" aria-label="View tmuxp documentation">Docs</a>All links are keyboard accessible:
Tabto navigate forwardShift + Tabto navigate backwardEnterto 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.
Every link on the site opens in the same tab. A page that must open a new tab adds rel="noopener noreferrer":
<a href="https://external.com" target="_blank" rel="noopener noreferrer"> External Site</a>target="_blank"- Opens in new tabrel="noopener"- Prevents window.opener accessrel="noreferrer"- Doesn’t send referrer information
- Use descriptive link text - Avoid generic “click here”
- Check link destinations - Ensure URLs are correct
- Consider link context - Surrounding text should make sense
- Test all links - Verify internal and external links work
- Provide alternatives - For important links, consider multiple paths
- Use HTTPS - Always prefer secure protocols
- 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