Markdown cheat sheet
For details, see Markdown Syntax Style Guide.
Basic Syntax
Headings
Heading syntax:
## Heading
Include blank lines before and after headings. (The first heading, or title, does not require a blank line before it, but all subsequent headings do.)
Bold and italics
Bold syntax: This is **bold** text
Displayed: This is bold text
Italic syntax: This is *italicized* text
Displayed: This is italicized text
Badges
Metadata: badge: label="Beta Content" type="Informative" url="https://www.example.com" tooltip="Go to example.com"
Inline: [!BADGE Beta Content]{type=Informative url="https://www.example.com" tooltip="Go to example.com"}
Inline example
[Beta Content]{class="badge informative" title="Go to example.com"}
Syntax
[!BADGE Beta Content]{type=Informative url="https://www.example.com" tooltip="Go to example.com"}
See Badges in the syntax guide.
Code blocks
Code (inline) syntax:
This is `code` text
Rendered:
This is code text
Code block (fenced):
Use three backticks ( ``` ) before and after the code lines. The open and close must have the same indent. Add blank lines above and below the code block.
Following the backticks, specify the programming language that is used, ie python, javascript, etc, and this will allow syntax highlighting on the front end. If no language is specified, no highlighting will be available.
Example:
Rendered code block:
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
Example with line numbers, new start line, and highlighting (````html {line-numbers=“true” start-line=“7” highlight=“11-13, 16”}`):
<!DOCTYPE html>
<html>
<body>
<h1>My First Heading</h1>
<p>My first paragraph.</p>
<p>My second paragraph.</p>
</body>
</html>
See Code blocks.
Collapsible sections
You can create a collapsible section (sometimes called an accordion) that is hidden by default. The user can click the title to expand or collapse the section.
Syntax
+++Click me
This is text inside a collapsible section.
+++
Example
See Collapsible sections.
Images
You can also resize the image, change its alignment, or allow users to click it to expand.
 {width="250" align="center" zoomable="yes"}
Rendered:
See Images.
Links and cross-references
[Adobe](https://www.adobe.com)
https://www.adobe.com
<https://www.adobe.com>
Rendered:
https://www.adobe.com
Links to internal articles:
See complete [Markdown Syntax Guide](https://experienceleague.adobe.com/docs/authoring-guide/using/markdown/markdown-syntax.html?lang=en)
See complete Markdown Syntax Guide
Root links:
[filename](/docs/authoring-guide/directory/otherdirectories/filename.md)
(root example) See complete [Markdown Syntax Guide](https://experienceleague.adobe.com/docs/authoring-guide/using/markdown/markdown-syntax.html?lang=en)
(root example) See complete Markdown Syntax Guide
Deep links:
Jump to [Change properties](#change-properties) heading at the end of this page.
See [Links and cross-references](https://experienceleague.adobe.com/docs/authoring-guide/using/markdown/markdown-syntax.html?lang=en#links-and-cross-references) in a different article.
Jump to Change properties heading at the end of this page.
See Links and cross-references in a different article.
Lists
Include blank lines before and after lists.
Important: Use the same syntax for lists within a document. For example, don’t combine * and + in the same file, or you’ll get a validation error.
Ordered List:
1. First item
1. Next item
1. Next item
- First item
- Next item
- Next item
Unordered List:
* First item
* Second item
* Third item
- First item
- Second item
- Third item
Nested List:
To preserve numbering, indent items between steps, and handle blank lines properly.
1. First item
>[!NOTE]
>
>Indented item between steps.
1. Second item
1. Third item
-
First item
[!NOTE]
Indented item between steps.
-
Second item
-
Third item
See Lists.
Localization tags
Use [!DNL] for certain solution names (such as Target) and third-party names (such as Microsoft Windows) that should remain in English. Use [!UICONTROL] for menu commands, dialog box options, and other UI items.
[DNL] for every solution name. The localization team handles common solution names such as Analytics, Audience Manager, and Campaign automatically.Target your objectives by using Target to perform A/B tests.
1. Click the **Process** command.
1. Choose **Print All** to print all the files on your server.
The Print All dialog box appears.
Metadata
Add metadata to the top of the markdown file. The next line after the metadata line (and blank line) MUST be the article title (# Title).
---
title: Title for search optimization.
description: This is the article description used for search optimization. Use common search keywords and synonyms.
---
# Article title {#optional-anchor}
For a list of required and optional metadata, see Metadata for AdobeDocs.
More Like This (“Related Articles”)
Use the “More Like This” component to display related links at the end of an article.
Syntax
Rendered
Notes
Syntax:
>[!NOTE]
>
>This is a standard NOTE block.
[!NOTE][!TIP][!IMPORTANT][!WARNING][!CAUTION][!ADMIN][!AVAILABILITY][!PREREQUISITES][!INFO][!ERROR][!SUCCESS][!MORELIKETHIS]
Rendered:
[!NOTE]
This is a standard NOTE block.
See Notes.
Shade Boxes
Shade boxes are useful for setting off a section of content from the rest of the page. To create a shade box, add >[!BEGINSHADEBOX] at the beginning of the section and >[!ENDSHADEBOX] at the end. All content between these begin and end tags will have a gray background.
Example:
Removing the border in an HTML table
In some cases, you use an HTML table to create a balanced design, but you don’t want the content to look like a table. To turn off a border for a one-row HTML table, use this syntax:
<table>
<tr style="border: 0;">
See Shade boxes.
Tables
| Syntax | Description |
| --- | --- |
| Column 1 | Column 2 |
| Paragraph | Text |
See Tables.
Tabs
A tab is a clickable area at the top of a section that shows different content. When a tab is clicked, the tab’s contents are shown, and the contents of other tabs is hidden.
To create a tab set, add >[!BEGINTABS] at the beginning of the tab set and >[!ENDTABS] after the last tab. Add >[!TAB <tab title>] tags for each tab section, and add the contents of each tab below it.
See Tabs.
Videos
The video extension allows the video to be played on the page. You can also create a standard link to the video.
>[!VIDEO](https://video.tv.adobe.com/v/17187/?quality=12&learn=on)
See Videos in the Syntax style guide for more information.
Less common components
CONTEXTUALHELP
Authors can work with product teams to add help popovers in the Experience Cloud or Experience Platform product UI.
>[!CONTEXTUALHELP]
>id="platform_destinations_activate_mandatorykey_2"
>title="About mandatory attributes"
>abstract="Select the XDM schema attributes that all exported profiles should include. Profiles without the mandatory key are not exported to the destination. Not selecting a mandatory key exports all qualified profiles regardless of their attributes."
>additional-url="http://www.adobe.com/go/destinations-mandatory-attributes-en" text="Learn more in documentation"
Includes and snippets
Use includes and snippets to share text within a repo.
Reference to Head2 content in help > _includes > snippets.md file:
{{id-name}}
Reference to include file:
{{$include /help/_includes/filename.md}}
For details, see the Markdown Syntax Style Guide.