Skip to main content

Markdown Basics

Markdown is a simple yet powerful way to format text, making it easy for you to create your documentation. The MDX pages you will create using WriteDocs accept both markdown and HTML.

This guide will introduce you to the basics of Markdown, helping you quickly get started.

Headers​

Use # to create headers. The number of # symbols indicates the header level.

# This is a heading 1
## This is a heading 2
### This is a heading 3

Emphasis​

You can add emphasis by using asterisks or underscores.

Bold: **bold text** or __bold text__
Italic: *italic text* or _italic text_

Lists​

Unordered list​

To create an unordered list, prefix each list item with a dash (-), an asterisk (*), or a plus sign (+):

  • Item 1
  • Item 2
  • Item 3
- Item 1
- Item 2
- Item 3

Ordered list​

To create an ordered list, add line items with numbers or letters followed by periods:

  1. First item
  2. Second item
  3. Third item
1. First item
2. Second item
3. Third item

Nested list​

Add indents to list items to nest them:

  • First item
  • Second item
    • Nested item
    • Nested item
  • Third item
- First item
- Second item
  - Nested item
  - Nested item
- Third item

Create hyperlinks using the following syntax:

[Link Text](https://example.com)

Images and Videos​

Use our Media component to add images and videos to your MDX pages.

Tables​

Tables in Markdown allow you to organize data in a structured way. Use pipes (|) to separate columns, and hyphens (-) to create the header row. You can also use online markdown table generators to turn your spreadsheets into markdown.

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |

This will render as:

Column 1Column 2Column 3
Row 1, Col 1Row 1, Col 2Row 1, Col 3
Row 2, Col 1Row 2, Col 2Row 2, Col 3

You can align text in the columns by adding colons (:) to the header row:

  • :--- aligns text to the left.
  • :---: centers text.
  • ---: aligns text to the right.

Horizontal Rules​

Add a horizontal rule by typing ---, ***, or ___. Check how it will look like: