Create a profile with a URL

Owned by Former user (Deleted)
Last updated: Jul 03, 2019
2 min read

Description

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

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 work with URLs in three ways:

Use the complete URL

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

  1. Navigate to CONFLUENCE ADMINISTRATION > General Configuration > BOB SWIFT CONFIGURATION > Markdown > Profiles.

  2. Click Add Profile.

  3. Enter BitURL in the Profile name 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 Profile.

7. In the Markdown from a URL macro, select BitURL from the Profile list.

8. 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 CONFLUENCE ADMINISTRATION > General Configuration > BOB SWIFT CONFIGURATION > Markdown > Profiles.

  2. Click Add Profile.

  3. Enter BitURL in the Profile name 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 Profile.

        

7. Select BitURL from the Profile list in the markdown-url macro editor. 

8. Enter the relative path to the Markdown file /bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md in the URL to markdown file parameter.

9. Click Save.

        

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 https://bitbucket.org/bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.md in the the URL to markdown file.
  2. Click Save.