Markdown Cheat Sheet

For details, see Markdown Syntax Style Guide.

Basic Syntax

Headings

Example:

## Heading

Include blank lines before and after headings. (The first heading does not require a blank line before it, but all subsequent headings do.)

Bold and italics

Bold: This is **bold** text

Italic: This is *italicized* text

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

1. First item
2. Next item
3. 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

   ![](/docs/authoring-guide-exl/assets/logo.png?lang=en)

1. Third item

1. First item

   [!NOTE]

   Indented item between steps.

2. Second item

   

3. Third item

Images

![logo](/docs/authoring-guide-exl/assets/logo.png?lang=en)

Links and cross-references

[Adobe](https://www.adobe.com)

https://www.adobe.com

<https://www.adobe.com>

Rendered:

Adobe

https://www.adobe.com

https://www.adobe.com

Links to internal articles:

See complete [Markdown Syntax Guide](/docs/authoring-guide-exl/using/markdown/syntax-style-guide.html?lang=en)

See complete Markdown Syntax Guide

Root links:

[filename](/docs/authoring-guide-exl/directory/otherdirectories/filename.md)
(root example) See complete [Markdown Syntax Guide](/docs/authoring-guide-exl/using/markdown/syntax-style-guide.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](/docs/authoring-guide-exl/using/markdown/syntax-style-guide.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.

Code blocks

Code (inline):

This is `code` text

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
}

Add {.line-numbers} after the language to enable line numbering.

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

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 {#unique-anchor}

For a list of required and optional metadata, see Metadata for AdobeDocs.

Advanced Markdown Syntax

Table

| Syntax | Description |
| --- | --- |
| Column 1 | Column 2 |
| Paragraph | Text |

Extended Markdown Syntax for Adobe documentation

Notes

Syntax:

>[!NOTE]
>
>This is a standard NOTE block.

>[!NOTE]
>[!TIP]
>[!IMPORTANT]
>[!WARNING]
>[!CAUTION]
>[!ADMIN]
>[!AVAILABILITY]
>[!PREREQUISITES]
>[!INFO]
>[!ERROR]
>[!SUCCESS]
>[!Related Articles]

Rendered:

[!NOTE]

This is a standard NOTE block.

Video

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/)

More Like This (“Related Articles”)

Use the “More Like This” component to display related links at the end of an article.

Syntax

Example

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.

Target your objectives by using [!DNL Target] to perform A/B tests.

1. Click the **[!UICONTROL Process]** command.
1. Choose **[!UICONTROL Print All]** to print all the files on your server.

   The [!UICONTROL Print All] dialog box appears.

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"

See Contextual Help Popovers.

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

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}}

Change properties

For example, change heading ID:

### My Heading {#custom-id}

For details, see the Markdown Syntax Style Guide.

Business.Adobe.com resources