Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added details about each macro

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:

...

Select any of the links to learn more:

  • Markdown

  • Markdown from Github

  • Markdown from Bitbucket

  • Markdown from Gitlab

  • Markdown from a URL

@How to use

You can pull Markdown from Bitbucket, from a URL, or through direct entry.

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printablefalse

Markdown

  1. Add the Markdown macro to the required Confluence page

...

  1. .

  2. Then paste your content into the macro editor:

...

  1. Image Added

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

...

  1. Image Added

  2. Click Insert and publish the page.

Markdown from

...

Github

  1. Add

...

Markdown from Github

Now simply select Markdown from Github on the macro page and select your desired token:

...

Markdown from Bitbucket

Now simply select Markdown from Bitbucket on the macro page and select your desired token:

...

Here's a breakdown of each field:

...

Field

...

  1. 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.pngImage Added

    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.gifImage Added
  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

The

Enter the username or organization name

in

under which the repository is hosted

under

.

For example

, if the URL for your repository was

:

https://bitbucket.org/ mohamicorp/search-for-stash

The username would be mohamicorp

Repository

The username the repository is hosted under. For example, if the URL for your repository was:

, 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

The repository would be search-for-stash

This is a mandatory field.

Branch or Commit Hash

The Branch which you want to pull documentation from. A good example is master

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

This is a mandatory field.

File Path

The

Enter the directory path where the file is hosted

under

.

A good

For example

might be

:

src/main/resources/README.md

This is a mandatory field.

Markdown from Gitlab

...

  1. Add the Markdown from Gitlab

...

  1. macro to the

...

Here's a breakdown of each field:

...

Field

...

Description

...

URL

...

  1. required Confluence page.

    mdExt_cld_macro_GL.gifImage Added
  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

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

configuration bellow is not required.

, 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

The

Enter the username or organization name

in

under which the repository is hosted

under

.

For example

, if the URL for your repository was

:

https://gitlab.com/mohami/smarter-search-for-bitbucket

The username would be mohami

Repository

The username the repository is hosted under. For example, if the URL for your repository was:

, 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

The repository would be 

, where the repository is smarter-search-for-bitbucket.

This is a mandatory field.

Branch or Commit Hash

The Branch which you want to pull documentation from. A good example is master

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

This is a mandatory field.

File Path

The

Enter the directory path where the file is hosted

under

.

A good

For example

might be

:

src/main/resources/

http://README.md

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.pngImage Added
  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