Parameters
...
Refers to the URL of the Markdown file.
Info |
---|
To know more about linking apps with Confluence, refer to Application Link. Since 3.4 |
...
Encoding for an external file if different from the system default handling.
Common parameters
...
Basic Use
This macro can be deployed using one of the following methods:
...
Screenshot
- Example using a public Bitbucket file: https://bitbucket.org/bob_swift/gint/raw/tip/README.md
...
Warning | ||
---|---|---|
| ||
Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data. |
The Markdown from a URL macro renders Markdown content from URLs or from profiles. Profiles are a means of retrieving data from other external sources such as other applications or even databases. You can read more about profiles from this link.
Info |
---|
Markdown content containing links or images referring to a public location can be accessed and then rendered. Currently, any links or images that refer to a private repository, or a location that must be logged in to, cannot be accessed and thus, rendered. |
Info | ||
---|---|---|
| ||
|
Basic use
This macro can be deployed using one of the following methods:
Selected from the Macro Browser | Markdown from a URL |
---|---|
Markup Shortcut | {markdown-url} |
Parameters
Macro specific parameters
Macro Editor Label | Default | Description | Macro Parameter | |||||
---|---|---|---|---|---|---|---|---|
Profile | Enter a profile name. Administrators set up profiles to connect to other applications such as GitHub or GitLab. Profiles contain a basic set of parameters used to access a remote location such as the type of URL, user credentials, and so on.
| profile | ||||||
URL to markdown file | Enter the relative path to the Markdown file to be displayed. If a valid path is entered here, the macro accesses the given location and processes the Markdown content accordingly. A profile comprises a base URL and other credentials that are required to access a specific application. These details point to the actual location where the required Markdown file is available. The contents are then accessed and displayed through the macro.
| url | ||||||
URL user (removed) | Enter the user name for the given URL to access the required Markdown file.
| user | ||||||
URL password (removed) | Enter the user password for the given URL to access the required Markdown file.
| password | ||||||
URL connection timeout | Enter time in milliseconds such that URL connections does not disconnect before getting data. Use this to increase the access time needed for slow connections. Note that if a zero is given the connection may wait infinitely. | timeout | ||||||
File encoding | UTF-8 | Specify the encoding for an external file, if different from default system handling. | encoding |
Note |
---|
It is mandatory to specify either a profile or a URL for this macro. |
Info | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Depending on the values provided for the Profile and URL to markdown file parameters, the following process applies:
|
Common parameters
The following parameters are available for all the Markdown macros:
Include Page Common parameters - Cloud Common parameters - Cloud
Screenshot
The following example uses an absolute URL in URL to markdown file of the macro settings: