Search

Custom domain

Vinh
Vinh
  • Updated
This feature is available on all paid plans. Want this and other premium features? Update your plan here.

What is a custom domain?

Setting up a custom domain allows you to point the viewer version of your styleguide to a bespoke/vanity URL that uses your domain rather than zeroheight. A typical zeroheight domain will look similar to this: https://zeroheight.com/12345/v/latest/p/12344aa-name-of-styleguide A custom domain name could be design.yourcompany.com. It could even be the name of your design system to help with building a community around your design system.

Request a custom domain

To have a custom domain, you must secure your own domain before requesting zeroheight to connect it to your styleguide.

1) Open your styleguide

2) Click ... in the top right and choose Styleguide settings

three dot menu for styleguide

3) In the Custom domain tab, enter the custom domain you would like to use and click Request

4) We will email you with instructions on setting up the required DNS record updates. email showing instructions on setting up DNS records 5) Type in your custom domain (i.e., designsystemhelp.mycompany.com) into your browser. You should see either the zeroheight login screen or an SSL error page. zeroheight log in page with your custom domain address in the address bar 6) Reply to the email letting us know when you've made the changes. 7) We will verify the settings and set up your domain. We will set up the SSL certificates for you using LetsEncrypt.org 👉 Note: It may take a few days for these changes to take effect.

Update links

You don't need to update links when you add a custom domain. Existing links within your styleguide will redirect correctly and you should see your custom domain in the URL bar.

Change custom domain title tag

The title tag for your styleguide is your styleguide name. Red arrow pointing to custom domain title tag Some styleguides have their name hidden. If your styleguide name is hidden and you wish to change it, you will need to display the styleguide name first. You can then hide the styleguide name again after. You change it in the cover page settings.

  1. Enable Display text
  2. Type in the styleguide name
  3. Toggle the Display text off again
  4. It should update the tag title with that name

Styleguide cover page settings with an arrow pointing to the Display text toggle

Custom domain favicons

Contact support@zeroheight.com to add, update, or remove a favicon from your styleguide.

Troubleshoot custom domains

Need help setting up your custom domain? Here are some tips on troubleshooting your issues.

FAQs

Can I have one custom domain for multiple styleguides?

Unfortunately,  you can't have one custom domain for multiple styleguides. You can only have one custom domain per styleguide.

Was this article helpful?