Skip to end of banner
Go to start of banner

Macros overview

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This article contains information about each macro available in the app.

You can pull Markdown from other applications like GitHub, Bitbucket, or GitLab, or, from a URL, or directly in the macro body. The list of macros and how to add one to a page are as shown in the image:

mdExt_cld_macrosList.png

Select any of the links to learn more:

Markdown

  1. Add the Markdown macro to the required Confluence page.

  2. Then paste your content into the macro editor:

    Or, you can paste the content directly in the macro on the page as shown:

  3. Click Insert and publish the page.

Markdown from Github

  1. Add the Markdown from Github macro to the required Confluence page.

  2. Select the Github token from the list and enter the path of the Markdown file to be displayed in URL.

    mdExt_cld_macro_GH.png

    Administrators configure these tokens from the Markdown Extensions Configuration page.

  3. Click Insert and publish the page.

Markdown fromĀ Bitbucket

  1. Add the Markdown from Bitbucket macro to the required Confluence page.

    mdExt_cld_macro_BB.gif
  2. Select the token in Bitbucket token and URL in the Enter URL tab. Click Check to check the connection.

  3. Enter the required information in the Enter Repository Settings tab and click Insert.

  4. Publish the page to view the accessed data.

The following table explains each parameter in the macro editor:

Parameter name

Description

Enter URL tab

Bitbucket token

Specify the Bitbucket account to be accessed. Administrators configure these tokens from the Markdown Extensions Configuration page. This parameter is common to both the tabs.

URL

Enter the full path to the required Markdown file. This is a mandatory field. If a URL is provided, the settings in the Enter Repository Settings tab can be skipped.

Click Check to test the connection and accessibility.

Enter Repository Settings tab

Username/Organization Name

Enter the username or organization name under which the repository is hosted. For example: mohamicorp

This is a mandatory field.

Repository

Specify the repository to be accessed. For example: search-for-stash

This is a mandatory field.

Branch or Commit Hash

Specify the branch from where the file is available. For example: master

This is a mandatory field.

File Path

Enter the directory path where the file is hosted. For example: src/main/resources/README.md

This is a mandatory field.

Markdown from Gitlab

  1. Add the Markdown from Gitlab macro to the required Confluence page.

    mdExt_cld_macro_GL.gif
  2. Select the token in Gitlab token and URL in the Enter URL tab. Click Check to check the connection.

  3. Enter the required information in the Enter Repository Settings tab and click Insert.

  4. Publish the page to view the accessed data.

The following table explains each parameter in the macro editor:

Parameter name

Description

Enter URL tab

Gitlab Token

Specify the GitLab account to be accessed. Administrators configure these tokens from the Markdown Extensions Configuration page. This parameter is common to both the tabs.

URL

Enter the URL of the Markdown file to be displayed. The URL can be a link to either a regular or a raw file. If a URL is provided, the settings in the Enter Repository Settings tab can be skipped.

For example: https://gitlab.com/mohami/smarter-search-for-bitbucket/-/blob/master/README.md

This is a mandatory field.

Enter Repository Settings tab

Username/Organization Name

Enter the username or organization name under which the repository is hosted. For example: mohami

This is a mandatory field.

Repository

Specify the repository name to be accessed. For example: smarter-search-for-bitbucket

This is a mandatory field.

Branch or Commit Hash

Enter the branch name where the file is located. For example: master

This is a mandatory field.

File Path

Enter the directory path where the file is hosted. For example: src/main/resources/README.md

This is a mandatory field.

Markdown from a URL

  1. Add the Markdown from a URL macro to the required Confluence page. The macro is displayed as a sidebar in the right:

    mdExt_cld_macro_URL.png
  2. Add your URL to the URL parameter. The changes made to the editor are always saved automatically. Make sure your URL is pointing to raw Markdown!

  3. Publish the page to see the content.

Additional resources

  • No labels