Sync markdown files from your code repositories

Vinh
Vinh
  • Updated

You can sync markdown files from Azure DevOps, GitHub, GitLab and Bitbucket with zeroheight. This will allow you to create documentation in markdown and display it on your zeroheight site.

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

 

Add repos

  1. In the Code Repos tab in the Uploads section, click "Add repos"Code 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. Select the file you want to import and this should now show on the page

  1. Selected repo in the code repos window

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 you support private repos?

Yes, you can import content from private repos. This content will then be visible to users based on your zeroheight privacy settings.

 

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 flavour of Markdown do you support?

The dialect of markdown we support is commonmark

Was this article helpful?