Insert Markdown from Git

image-20251103-101704.png

#Before you start

  • Connect your GitHub account (and ensure org approval/SSO if required).

  • Confirm you have access to the repository and branch containing the file.

#Supported formats

  • .md, .markdown, .mdx

#Insert steps

  1. In your page or work item, insert the Github File macro

image-20260107-131437.png

  1. If prompted, connect your Git account and select the correct account.

  2. Search or browse to the repository, then pick the branch.

image-20260107-131653.png

  1. Navigate folders and select the Markdown file.

image-20260107-131859.png

  1. (Optional) Edit the title shown above the content.

  2. Insert to add the Markdown to your page/work item.

#How it renders

  • Markdown is rendered as rich content including headings, lists, links, code blocks, and tables.

  • Images referenced with absolute URLs will display; private images require accessible URLs.

#Permissions

  • Viewers must have their own access to the repository. If they don’t, they’ll be prompted to connect or will see an access error.

#Troubleshooting

  • File not listed: Check the selected account, branch, and repository permissions.

  • Images don’t show: Ensure the image path is publicly accessible or embedded as an inline image in the page.