Skip to end of banner
Go to start of banner

Markdown-url macro

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

Parameters

Macro Browser LabelParameterDefaultDescription
Profileprofile
Default parameters provided by the Administrator. Some profiles may be restricted. Since 2.0.
URL to Markdown fileurl

Refers to the URL of the Markdown file. 

  • For Markdown files available on apps linked to Confluence, entering the username and password parameters may not be necessary.
    • If you are rendering the file in the Markdown macro for the first time, you are asked to authorise the app via Click to authorise link. For subsequent requests, the app will work seamlessly.
    • File permissions will apply based on the user profiles and respective levels of access in the linked App.
  • You need to enter the Rest API pattern for GitHub or GitLab URLs.

 To know more about linking apps with Confluence refer to Application Link. Since 3.4

URL useruser
The user name for URL access that requires basic authentication.
URL passwordpassword
User password for URL access that requires basic authentication.
URL connection timeouttimeout
Used to increase the wait time for URL access on slow connections.
File encodingencodingUTF-8

Encoding for an external file if different from the system default handling.

Common parameters

Macro browser labelDefaultDescriptionMacro parameter
Idgenerated valueEnter the HTML ID of the div element surrounding the content.id
Find regex patterns

Enter a comma-separated list of regex patterns to dynamically update the output for Markdown content with find and replace logic.

Example: (href=)(/display)

find

Enter a comma-separated list of positions to search for patterns in the output content. Note that the positions are indexed beginning at "1". If a comma is a part of the search, use single quotes (') around it.

Example: http://www.google.com/$1

replace
Allow HTML tagsfalseEnable this option to allow embedded HTML tags in Markdown macros. This is a potential security exposure, so it is disabled by default. The Confluence administrator must explicitly authorize users or groups using Macro Security for Confluence.allowHtml
Hard wrap newlinestrue

Determines how newlines are treated. This is a GitHub Flavored Markdown extension that defaults to being turned on.

TextHard wrap (selected)Soft wrap (Hard wrap not selected)
Roses are red
Violets are blue
Roses are red
Violets are blue
Roses are red Violets are blue
hardwrap
Anchor links for headingsfalseEnable this option to automatically add anchor links for headings.headerLinks
Table class@default

Enter the CSS to be applied to rendered tables. 

  • @default - Apply default Confluence table class to rendered tables.
  • @none - Do not apply any style for rendered tables. 
  • userDefinedClass - Use a custom user-defined style for rendering Tables.
tableClass

Basic Use

This macro can be deployed using one of the following methods:

Selected from the Macro BrowserMarkdown from a URL
Markup Shortcut{markdown-url}

Screenshot

  • No labels