Add links

Vinh
Vinh
  • Updated
You'll often need to add links in your documentation, so here are some quick tips for adding links in zeroheight.

Shortcut tiles

You can add shortcut tiles anywhere in your style guide. They are particularly useful on the cover page but can be used throughout your documentation. Shortcut tiles can link to a different section of the style guide, a different style guide, or to any URL. Shortcut tile examples

Add a shortcut tile

You can add a shortcut tile from the toolbar:

Top navigation bar

It's possible to add links in the top navigation bar. This can be useful to link to resources such as your code repository. You can also use these links to provide navigation back to a landing page or to internal resources secured by SSO. Top navigation bar

External links

To add a link, click Add navigation in the top navigation bar and choose External link: Top navigation options

Internal links

You can create internal links by linking to a page or page headers within your styleguide. Internal links example

Text links

Select some text and choose the link option from the toolbar: text toolbar

Rich previews

If you paste a link, you'll be able to turn it into a rich preview or an embed (or keep it as a link). Popover menu showing for a link Rich previews show the page title, description and images supplied by the page. Rich preview for links in zeroheight Use the three dot menu to open the link, turn it back into a text link or, turn it into an embed. A popover showing actions for rich previews

Images

You can add links to images in your styleguide. Hover over your image and click the link icon to add a URL. Add links to images when hovering over image

Change the link color

You can change the color of your links from for your theme in the Theme Settings: Changing the link color in the theme editor

Other tips

Copy links in zeroheight

Make sure to copy links in zeroheight using the copy actions available on the page. You can copy links to header by hovering over the header and clicking the Copy link to header option in the menu: Copy link to header function hovered over
You can also copy from the sidebar by clicking the ... next to the page name and choose Copy link: Copy link function in the three dots menu for the sidebar

Custom domain

If you add a custom domain to your styleguide there is no need to change any of the links. zeroheight will resolve the links automatically.

Was this article helpful?