Versions Compared

Old Version 1

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 2

changes.mady.by.user Smita Nair

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This article illustrates how to create a Profile profile in the Markdown macro macros using a URL.

Info

Before you begin:

  • Before you enter the URL for a repository, ensure that it complies with the REST standards published by GitHub or GitLab.
    • Click here for more information on REST Pattern for GitLab.
    • Click here for more information on REST Pattern for GitHub.
  • Know what is a complete URL. A typical path for the raw file on GitLab looks like:
    /projects/:id/repository/files/:file_path/raw
  • Since the host address begins with:
     https://gitlab.com/api/v4
  • The complete URL, in this example, looks like: 
 https://gitlab.com/api/v4/projects/:id/repository/files/:file_path/raw?ref=master
  • For illustrative purposes, we have used a public Bitbucket public repository. The process for adding a profile and using it in macros remains the same for other repositories and external sources.


You can There are three ways to work with URLs in three ways:which are explained in the sections below.

Use the complete URL

You can create a profile by providing the complete URL for the Markdown content.

  1. Navigate to Markdown CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Manage apps General Configuration > BOB SWIFT CONFIGURATION > > Bob Swift Atlassian Add-ons - Markdown > Configure > Profiles.

  2. Click Add Profile.

  3. Enter BitURL a unique name for the profile in the Profile name text box. For this example, enter BitURL in the text box.
  4. Select URL from the options in Profile type. 

  5. Enter https://bitbucket.org/bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md in the URL text box. 

  6. Click Save profile to create a Profilethe profile.
    Image Modified

...

To use this profile in a Confluence page:

  1. Search for the Markdown from a URL macro

...

  1. and edit it.
  2. Select BitURL from the Profile list

...

  1. and then, click Save.

        

Use a fixed URL

You can create a profile by providing a fixed URL for the Markdown content and enter the relative path to the Markdown file in the markdown-url macro.

  1. Navigate to Markdown CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Manage apps General Configuration > BOB SWIFT CONFIGURATION > > Bob Swift Atlassian Add-ons - Markdown > Configure > Profiles.

  2. Click Add Profile.

  3. Enter BitURL a unique name for the profile in the Profile name text box. For this example, enter BitURL in the text box.
  4. Select URL from the options in Profile type. 

  5. Enter https://bitbucket.org in the URL text box.

  6. Click Save profile to create a Profileprofile to create the profile.

        7. Select BitURL

To use this profile in a Confluence page:

  1. Search for the markdown-url macro and edit it.
  2. Select BitURL from the Profile list in the

...

  1. editor.

...

...

  1. Enter the relative path to the

...

  1.  /bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md Markdown file in the URL to markdown file parameter.

...

  1. Click Save.

        

Info

This method allows multiple users to access a profile across pages and instances of the markdown-url macro. 

Skip creating a profile

You can skip creating a profile and provide the complete URL in the URL to markdown file parameter in the macro editor.

  1. Enter 

...

  1. Enter https://bitbucket.org/bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md in  in the the URL to markdown file parameter.
  2. Click Save.

     

...