Versions Compared

Key

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

...

This article illustrates how to create a profile in the Markdown 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 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.

...

There are three ways to work with URLs where you can use:

For this example, let's consider using profiles with the HTML macro.

Anchor
MD_Cld_HowTo_CompleteURL
MD_Cld_HowTo_CompleteURL
Using an absolute URL in a profile

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

  1. Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Markdown Configuration > ProfilesHTML > Profiles.

    Tip
    titleTry this for newer Confluence versions

    Select Image Added > Manage apps, either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view app configuration.


  2. Click Add Profile.

  3. Enter 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.mdhtml in the URL text box. 

  6. Click Save profile to create the profile.

To use this profile in a Confluence page:

  1. Search for the Markdown from a URL macro and edit itAdd the HTML macro or edit an existing macro on the page.
  2. Select BitURL from the Profile list and then, click Save.
    <screenshot>

        

Anchor
MD_Cld_HowTo_FixedURL
MD_Cld_HowTo_FixedURL
Using a partial URL in a profile

You can create a profile by providing a partial URL for the Markdown content to access the remote location and entering relative path to the Markdown relevant file in the markdown-url HTML macro.

  1. Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > Markdown Configuration > ProfilesHTML > Profiles.

    Tip
    titleTry this for newer Confluence versions

    Select Image Added > Manage apps, either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view app configuration.


  2. Click Add Profile.

  3. Enter 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 the profile.

...

To use this profile in a Confluence page:

  1. Search for the markdown-url macro and edit itAdd the HTML macro or edit an existing macro on the page.
  2. Select BitURL from the Profile list in the editor.
  3. Enter the relative path to the /bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md Markdown file in the URL to markdown file parameterhtml file in the Location of HTML data parameter.
  4. Click Save.
    <screenshot>

        

...

You can skip creating a profile and enter the absolute URL in the URL to markdown file parameter.

  1. In a Confluence page, search for the Markdown from a URL macro and edit it.
  2. Enter https://bitbucket.org/bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md in the the URL to markdown file parameter.
  3. Click Save.

...

Info

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

...

macros.