Help Center

Sync markdown files from GitHub

Sync markdown files from GitHub

This feature is available for Professional and Enterprise plans. This is not available for legacy Professional and Enterprise plans. Want this and other premium features? Update your plan here.

You can sync markdown files from GitHub into zeroheight. This will allow you to create documentation in markdown and display it on your zeroheight site.

You can benefit from GitHub features like version control and contribution while still centralizing your documentation in one place. Any updates to the file can be synced in zeroheight.

There is a limit to the number of GitHub repos you can connect to your team in zeroheight, depending on your plan. Read more on how to connect GitHub and the number of repos you can connect here.

Add repos

  1. In the Code Repos tab in the Uploads section, click “Add reposCode repos section in Uploads
  2. Select the repos you want to add and click Continue
  3. You will then see this repo, and any other you add, on the Code repos page. On this page, you can also control what branch you are pointing to.

List of repos in the Code Repos section

Add markdown file

  1. Click Markdown in the toolbar
  2. Markdown functioned hovered over in toolbarSelect the file you want to import
  3. Selected repo in the code repos windowYour file should now show in the page

Code repo in zeroheight styleguide

How markdown appears to viewers

Your markdown files will appear as regular documentation to viewers—the same as if it was written in zeroheight.

Markdown files shown the styleguide in viewer mode

👉 Note: We recommend not using H1 headings in MD docs that you sync to zeroheight. In zeroheight, H1 headings are used for the page title, and H2 is the largest heading for a page. Due to this, they will appear in zeroheight; however, they won’t show in the page outline menu.

Update markdown files

From the styleguide menu

  1. In your styleguide, click the three dots menu in the top right
  2. Click Update synced markdown

FAQs

Do my GitHub repos need to be public?

Your repos do not need to be public, content imported from a private repo will still be visible to all users.

Do you support HTML written within Markdown files?

We currently don’t support HTML and sanitize it so it may just show up as plain text in the preview.

What flavor of Markdown do you support?

The dialect of markdown we support is commonmark