Hyperlinks in CI Docs

Properly formatted hyperlinks help readers scan for important information and identify outside resources. When a screen reader encounters a hyperlink, it announces “link” — so there is no need to include the words “link” or “link to” in your link text.

Screen readers can also generate a “links list” that allows users to navigate directly to any link on a page without reading the surrounding content. This is only useful when link text is descriptive. A list of links that all read “click here” or “read more” provides no useful information at all.

Rules to follow

  • Identify the purpose of the link as part of the link text.
  • Be descriptive but concise. Screen reader users must listen to the full link text before moving to the next one.
  • Integrate the link into your sentence. Sighted readers will see it in context, and screen readers will announce it naturally.
  • Make links useful on their own, independent of surrounding text. If the link were pulled into a list, would it still make sense?
  1. Select the text you want to turn into a link.
  2. Press Ctrl+K (Windows) or Cmd+K (Mac), or go to Insert > Link in the menu bar.
  3. Paste or type the URL in the link field.
  4. Click Apply.

To edit or remove an existing link, click the link text and select Edit or Remove from the small menu that appears below it.

Hyperlinking Examples

The following examples show less and more accessible approaches to the same hyperlink. In each pair, the first option is a less accessible approach and the second is the improvement. Consider how each would sound if read aloud as part of a links list.

Example 1

Example 2

Example 3

Example 4

In each case, the more accessible option works on its own — even without the surrounding sentence to provide context.

Resources

Updated on May 8, 2026
Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Submit a Help Request

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

css.php