...
...
...
...
You can pull markdown from Bitbucket, from a URL, or through direct entry.
Entering Markdown Directly In-Page
Choose the Markdown macro in the Confluence macro page:
...
Then paste your macro into the content box:
...
Or you can use the content box on the page:
...
Markdown from a URL
Add your URL to the URL field, and click save. Make sure your URL is pointing to raw markdown!
...
Markdown from Github
First, you need to authorize your GitHub account by going to the plugin configuration page.
...
Type in a name that you want to remember the token by, then click Create New Link.
...
You'll be redirected to the intermediate page:
...
This page describes the various administrative functions available for all the macros available with the app. Select any of the following links for more information:
| Table of Contents | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Configuring the app
To access and get information from sources like GitHub, GitLab, and Bitbucket, you must create an OAuth 2.0 access token. This is done from the configuration page accessed from Settings (
) > ATLASSIAN MARKETPLACE (in the left sidebar) > Markdown Extensions Configuration.
...
Authorizing the app to access applications
This section describes how you can configure access to Github, Bitbucket, and Gitlab application, that is, the initial three tabs in the page. The process of authentication is similar regardless of the application to be accessed.
You can perform the following actions on the tokens:
For some reason, if need be, you can Delete a token. But, if you do so, all the macros that used this token will fail, and the pages will display errors. Thus, you must think carefully before using this feature.
If, for any reason, a token expires or has issues, the page(s) with the macro(s) using this token will show errors. If so, click Reauthorize to create a fresh token. Doing so, does not affect the existing macros using this token.
Select the relevant application from below to know more:
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Authorizing app to access Github
First, you need to log in to your GitHub account, and then, allow access to the required repository or Markdown file.
In the Markdown Extensions Configuration page, select the Github tab.
Type in a token name that’s easy to remember; then, click Create New Link.
An intermediate page opens:
Check address of Atlassian cloud instance and token name. If everything looks correct
...
, click Start workflow button.
...
Sign in to your Github account.
Next, an authorization page
...
is shown. Click Authorize.
...
If you have concerns about data and privacy, check out our privacy policy
...
.
...
...
Next, provide the password of your GitHub account and click Confirm. With this, you are redirected to the configuration page.
After this, you should now be able to see your token in the tablelist on the Github tab. You can add multiple accounts by logging into in to a new Github account and allowing access to the file.
Now simply select Markdown from Github on the macro page and select your desired token:
...
Markdown from Bitbucket
required file. To make data private, you must provide permissions to the required repositories through Github.
Authorizing app to access Bitbucket
First, you need to authorize log in to your Bitbucket account by going to the plugin configuration page.
...
, and then, allow access to the required repository or Markdown file.
In the Markdown Extensions Configuration page, select the Bitbucket tab.
Type in a token name
...
that’s easy to remember
...
, and then, click Create New Link
...
. This is similar to the step 1 mentioned under Github authorization section.
You are then redirected to the intermediate page.
...
Check address of Atlassian cloud instance and token name. If everything looks correct
...
, click the Start workflow button.
...
Next, you are redirected to an authorization page
...
. Click Grant Access.
...
If you have concerns about data and privacy, check out our privacy policy
...
.
...
You're done! You should now be able to can see your token in the tablelist on the Bitbucket configuration page. You can add multiple accounts by logging into a new Bitbucket account and allowing access to the file.
Now simply select Markdown from Bitbucket on the macro page and select your desired token:
...
Here's a breakdown of each field:
...
Field
...
Description
...
Username/Organization Name
...
The username or organization name in 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:
https://bitbucket.org/mohamicorp/search-for-stash
The repository would be search-for-stash
...
Branch or Commit Hash
...
The Branch which you want to pull documentation from. A good example is master
...
File Path
...
The directory the file is hosted under. A good example might be:
src/main/resources/README.md
...
Authorizing app to access Gitlab
First, you need to authorize your Gitlab account by going to from the plugin configuration page and select .
In the Markdown Extensions Configuration page, select the Gitlab tab.
...
Type in a
...
token name, and then, click Create New Link.
...
You'll be redirected to the intermediate page:
...
This is similar to the step 1 mentioned under Github authorization section.
An intermediate page is shown:
Check address of Atlassian cloud instance and token name. If everything looks correct
...
, click the Start workflow button.
...
An authorization page
...
is shown. Click Authorize.
...
If you have concerns about data and privacy, check out our privacy policy
...
.
...
After completing this, you can see your token in the tablelist in the Gitlab tab. You can add multiple accounts by logging into a new Bitbucket account and allowing access to the file.
Now simply select Markdown from Gitlab on the macro page and select your desired token:
...
Here's a breakdown of each field:
...
Field
...
Description
...
URL
...
URL of the markdown file you want to get pulled to Confluence. Can be a link to either regular or raw file. If URL is provided configuration bellow is not required.
https://gitlab.com/mohami/smarter-search-for-bitbucket/-/blob/master/README.md
...
Username/Organization Name
...
The username or organization name in 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:
https://gitlab.com/mohami/smarter-search-for-bitbucket
The repository would be smarter-search-for-bitbucket
...
Branch or Commit Hash
...
The Branch which you want to pull documentation from. A good example is master
...
File Path
The directory the file is hosted under. A good example might be:
...
Access tokens imported from server
This tab contains information regarding the tokens imported from server post migration.
...
See the Migration guide to learn more about how the tokens work after migration.