List table (:::list-table)

There are two ways to render a table:

1. list-table directive

   Markdown

   :::list-table
   
   - - header1
     - header2
   - - item1
     - item2
   
   :::

2. GitHub Flavored Markdown (GFM) Table

   Markdown

   | Header 1 | Header2 |
   | -------- | ------- |
   | item1    | item2   |

The key differences are that GFM Tables are meant more for single line content (multi-lines require use of <br/><br/> tags), and non-text directives are not supported. Use the list-table directive for complex nested structures or multi-line content.

An additional feature available via the list-table directive is card styling (:::list-table{style='cards'}). This requires each row of the table to have exactly 2 columns (i.e. each list in the directive to contain a list with exactly 2 elements). The table's header row is then ignored, while each subsequent row is rendered as a card, with the first column being the card's title (which must be a link) and the second column being the card's body. However, in Azure docs, card styling is unavailable and such list-tables are instead rendered exactly like regular list-tables (including the header row) - therefore, it's important to still provide a header row with appropriate labels.

Example:

Markdown

:::list-table

- - header1
  - header2
- - list1
    - item
    - item
    - nested list:
      - item
      - item

    list2
    - item
    - item

  - Paragraph 1

    Paragraph 2 - blank line required before and after.

- - **Another row**
  - Another row of content

:::

| header1 | header2              |
| ------- | -------------------- |
| row1    | line1<br/><br/>line2 |
| row2    | **bolded text**      |

:::list-table{style='cards'}

- - Header describing card titles
  - Header describing card bodies
- - [Card 1 title](https://www.databricks.com)
  - Card 1 body
- - [Card 2 title](https://www.databricks.com)
  - Card 2 body
- - [Card 3 title](https://www.databricks.com)
  - Card 3 body

:::

Output:

header1	header2
list1 item item nested list: item item list2 item item	Paragraph 1 Paragraph 2 - blank line required before and after.
Another row	Another row of content

header1	header2
row1	line1 line2
row2	bolded text

• • Card 1 title
  • Card 1 body
• • Card 2 title
  • Card 2 body
• • Card 3 title
  • Card 3 body