Page Linking

Linking to pages (cross-referencing) is very powerful. It ensures that the pages hierarchy is always correct by automatically updated references as your documentation scales and changes. Linking to pages applies between pages in one version.

Why to Link Pages?

When a page is linked inside a version:

• The link will follow the page regardless of changes in documentation or page name.
• On cloning versions, the link will follow the page in the new version.
• You will be notified if a link breaks because a page was deleted.

How to Link Pages?

To create a link between pages, type @ to open the pages selector.

Pages selector open

A list of all pages under the version will be listed for you to choose from. Search through the list by typing down the page name or slug. To select a page, click on its name in the list. If you are selecting an API Reference, then you'll find the title of the API Reference.

Changing Link Title/Specifying Heading

After selecting the page, you will be prompted to change the link text (title) and optionally to link to a specific heading if you selected a page, or link to a specific operation if you selected an API reference.

Note: If you do not specify a title, then the title will automatically update whenever the linked page title changes. For example, if you linked to page "Getting Started", and then you modified "Getting Started" page title into "Welcome", then the link text will automatically change to "Welcome".

Changing link title and specifying heading

If you want to jump to a certain heading in a page, you can specify it. Start typing to find a heading in the page you selected, or click on the arrow to view all. Leaving Heading empty will default to jumping to the title of the page. The same goes for API references, where you can select a specific operation to jump to.

Once you select a heading/operation, its URL fragment will appear. A fragment is the part of the link that is after the hash sign # . For example, the link https://pied-piper.developerhub.io/v1.0/middle-compression/intro#how-to-use has the fragment how-to-use.

Fragment can only contain alphanumeric characters and hyphens.

Analyse Links

Analysing links helps you understand the links that are:

• Broken because the linked page/reference was deleted.
• Leading to an unpublished page/reference from a published page.
• Have an internal DeveloperHub link, instead of a link to your published docs.

Listing Broken Links

If a link between pages or references is unreachable, then you will be notified below the page title of the link analysis results. Link analysis runs automatically every time a page loads.

Broken link notification

Analyse Links for Entire Version

You can analyse all links in a version at once by:

• In the sidebar, open Version .
• Click on Analyse Links.

View Broken Links in a Page

To view all the links analysis in a page, either click on the notification under the page title or:

• From the right sidebar, open Page Info .
• View all broken links and link issues under Link Analysis.

Every broken link will show you the title and the heading (if any) that it had before breaking. The list also shows the current text of the link so you are able to find it and fix it.

Listing Linked Pages (Backlinks)

If you are planning to delete a page, or modify the page heavily, then you might want to know what other pages are depending on this page. To list all pages linking to the current page you are on:

• From the right sidebar, open Page Info .
• Click on Get Links .
• All links will be shown below, if any.

Page Permalinks

Permalinks are links that never change providing a reliable reference to a page.

To get a page permalink:

• From the right sidebar, open Page Info .
• Click on the page ID just below the title.
• The link will be copied to your clipboard.

Our permalinks have the following structure: https://<domain>/_permalink/<id>.