Using Markdown on the Platform

The platform can support the use of markdown for the following Board items:

  • Discussions
  • Tickets
  • Alerts
  • Reviews
  • Comments

Markdown is enabled or disabled via the Business Settings operations: for a list of applicable operations, see Businesses Service: Overview.

When markdown is enabled, users can upload artifacts when creating a board item, so that the item can have inline formatting, such as bold, italics, strikethrough, heading style, and underlines. It can also include uploaded images, which are displayed inline, and other uploaded files, which are displayed as links that viewers can click to open or download the file.

When using the API to add Discussions, Tickets, Alerts, or Reviews with artifacts, perform the following actions, in sequence:

  1. Upload the first artifact. As a result of this operation, the Board Item ID is assigned. Operation: POST /api/boards/items/artifacts.
  2. If applicable, upload subsequent artifacts. Operation: POST /api/boards/items/{BoardItemID}/artifacts.
  3. Finally, save the board item, with artifacts. In the developer portal, this happens when the user clicks Post or Submit to commit the content. The operation depends on the type of Board item. For example, for a ticket, it is: POST /api/tickets.

For Comments, the sequence is essentially the same, with a different set of operations:

  1. Upload the first artifact. As a result of this operation, the Comment ID is assigned. Operation: POST /api/boards/items/comments/artifacts.
  2. If applicable, upload subsequent artifacts. Operation: POST /api/boards/items/comments/{CommentID}/artifacts.
  3. Finally, save the comment, with artifacts. The operation depends on the type of Board item. For example, for a discussion, it is: POST /api/discussions/{DiscussionID}/comments.

For more information, and examples, refer to the documentation for the specific operations.

Back to top

Related Topics