How to configure Github profile and the markdown URL

This article helps in configuring the Github profile within the Markdown configuration and also explains how to pass the URL to the markdown file within the macro.

Instructions

1. Log in to Jira as an Administrator to configure the Markdown app.
2. Under Manage Apps → Markdown for Confluence, click Configure.
3. Navigate to Profiles → Add profile.
4. Give a Profile name and select the Profile type as Github.

5. Specify the URL as:

   https://api.github.com/repos

6. Pass the Username and Access token of the Github account.
   
   Note: Refer to this document for generating access tokens: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
   
   
   
7. Click on Save Profile.
8. Now, navigate to the page where the macro Markdown from a URL is used or Insert the macro to configure it.
9. Click on the macro to edit it and pass the profile name (that is created through the above steps) in the profile parameter.

10. Within the URL to markdown file parameter, pass the value in the given format:

    /{owner}/{repo}/contents/{file-path}

    
    Refer to this GitHub documentation for getting repository content format: https://docs.github.com/en/rest/reference/repos#get-repository-content
    
    
    
    

11. Publish the page to see the results of the markdown file.

Profile Allowlist:

The regular expression is tested here: https://www.freeformatter.com/regex-tester.html

Test results: