Editor

Add hyperlink

Overview

Add hyperlinks to your documents to connect to other content, both internally within your documentation and externally to outside references. Maintain link integrity with easy management features that highlight broken links, ensuring your content remains reliable.

To add an internal link in DocsHound, begin by selecting the text you want to hyperlink. This action will bring up the formatting toolbar.

  1. In the formatting toolbar, click on the Link button.

  2. In the link insertion dialog, navigate to the Internal tab.

  3. Enter the desired internal link in the Link input field.

  4. Click the Insert button to add the link.

Once inserted, the link will persist even if the title of the target page changes.

To add an external hyperlink, start by selecting the text you want to link. The formatting toolbar appears above the selected text. Click the Link button in the toolbar.

When the link insertion dialog opens, choose the External tab. In the Link input field, type or paste the URL you want to link to.

You can choose to open external links in a new tab by toggling the Open in new tab switch. Finally, click the Insert button to add the hyperlink.

In DocsHound, broken links are visually indicated by displaying the link text in red with a strikethrough. This allows you to quickly identify hyperlinks that need corrections.

  1. Regularly review your documentation for links in red with a strikethrough.

  2. Click on the broken link to open the link insertion dialog.

  3. Update the URL in the Link input field or choose a new link type (Internal or External).

  4. If applicable, toggle the Open in new tab switch.

  5. Click the Insert button to save the changes.

Check for broken links

Regularly checking for broken links helps maintain the accuracy and reliability of your documentation. Keeping links updated prevents user frustration and ensures information stays relevant.