# 使用 Markdown

Markdown 是一种简单的标记语言，允许您通过为其添加格式来增强纯文本。

## 为什么要使用 Markdown？

使用 Markdown，您可以通过添加标题、粗体、斜体、图片、链接等，让纯文本更加醒目。

API 契约让 Markdown 变得简单，即使对于初学者也是如此。得益于内置编辑器，您无需了解 Markdown 语法即可使用它。

Markdown 有不同的类型，API Contracts 支持 [CommonMark](http://spec.commonmark.org/0.25)、[表格](https://help.github.com/articles/organizing-information-with-tables/)、表情符号以及其他几种。

## 您可以在哪里使用 Markdown？

您可以在所有描述字段以及文本块中使用 Markdown。

判断是否支持 Markdown 的一个简便方法是，文本输入框顶部会显示 Markdown 工具栏。

![例如，当您编写 API 描述时，Markdown 工具栏会显示在文本输入框的顶部。](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Resources/Images/ApiDesigner/markdowneditor.png)

支持 Markdown 的文本框允许您进入全屏模式，并同时打开 Markdown 视图和渲染视图。只需点击 Markdown 工具栏右侧的拆分窗口图标。