The Markdown-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.
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; watch this ticket for updates. |
Info | ||
---|---|---|
| ||
|
Parameters
Macro Browser Label | Parameter | Default | Description | ||||
---|---|---|---|---|---|---|---|
Profile | profile | Default parameters provided by the Administrator. Specify a profile to be used with the macro. 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. Some profiles may be restricted. Since 2.0.
| |||||
URL to Markdown file | url | Refers to the URL of the 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 user | user | The Enter the user name for the given URL access that requires basic authenticationto access the required Markdown file. | |||||
URL password | password | User password for URL access that requires basic authenticationEnter the user password for the given URL to access the required Markdown file. | |||||
URL connection timeout | timeout | Used Enter time in milliseconds such that URL connections does not disconnect before getting data. Use this to increase the wait access time needed for URL access on slow connections. Note that if a zero is given the connection may wait infinitely. | |||||
File encoding | encoding | UTF-8 | Encoding Specify the encoding for an external file, if different from the from default system default handling.handling. |
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
Include Page Common parameters Common parameters
Basic
...
use
This macro can be deployed using one of the following methods:
Selected from the Macro Browsermacro browser | Markdown from a URL |
---|---|
Markup Shortcutshortcut | {markdown-url} |
Screenshot
- Example using a public Bitbucket file: https://bitbucket.org/bob_swift/gint/raw/tip/README.md
...