Versions Compared

Key

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

...

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
styledefault
exclude
typelist
class
printablefalse

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.

...

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: https://bitbucket.org/ mohamicorp/search-for-stash, where, the username is mohamicorp.

This is a mandatory field.

Repository

Specify the repository to be accessed. For example: https://bitbucket.org/mohamicorp/ 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 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.

...

Parameter name

Description

Enter URL tab

Gitlab 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 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: https://gitlab.com/mohami/smarter-search-for-bitbucket, where the username is mohami.

This is a mandatory field.

Repository

Specify the repository name to be accessed.

For example: In https://gitlab.com/mohami/smarter-search-for-bitbucket, where the repository is 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.

...