Using markdown - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Markdown is a simple markup language that allows you to enhance plain text by adding formatting to it.

Why should you use markdown?

With markdown, you can make plain text stand out by adding headers, bold and italics, images, links, and more.

Talend Cloud API Designer makes markdown easy, even for beginners. Thanks to the built-in editor you do not need to know markdown syntax to use it.

There are different types of markdown, and Talend Cloud API Designer supports CommonMark, tables and emojis, and a few others.

Where can you use markdown?

You can use markdown in all description fields, as well as in text blocks.

An easy way to know if markdown is supported is when the markdown toolbar appears at the top of the text input box.

Markdown-enabled text boxes allow you to enter fullscreen mode with both markdown and rendered views open at the same time. Just click the split window icon in the right part of the markdown toolbar.