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 +, 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)

logo

[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 [Using processing rules](admin/getting-started/processing-rules.md)
See complete [Markdown Syntax Guide](markdown-syntax-guide.md)

See complete Markdown Syntax Guide

Root links:

/help/directory/otherdirectories/filename.md

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:

code block example

Rendered code block:

{
  "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 |
Syntax Description
Column 1 Column 2
Paragraph Text

Extended Markdown Syntax for Adobe documentation

Notes

We support Note, Tip, Important, Caution, and Warning. New tags include Prerequisites, Admin, and Availability.

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.

TIP

This is a standard tip.

IMPORTANT

This is an important note.

WARNING

This is a warning.

CAUTION

This is a caution.

ADMINISTRATION

This is an admin note. EXL only.

AVAILABILITY

This is an availability note. EXL only.

PREREQUISITES

This is a Prerequisites note. EXL only.

INFO

This is an Info note. EXL only.

ERROR

This is an Error note. EXL only.

SUCCESS

This is a Success note. EXL only.

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

More Like This 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.

NOTE

It is not necessary to use [DNL] for every solution name. The localization team handles common solution names such as Analytics, Audience Manager, and Campaign automatically.

NOTE

It is OK to use localization tags in HTML or code blocks because the tags will be stripped out during packaging for publication.

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.

markdown

See Contextual Help Popovers.

Change properties

For example, change heading ID:

### My Heading {#custom-id}

For details, see the Markdown Syntax Style Guide.

On this page