List types

Basic examples

Unordered List

Ordered List

Custom Start Number

Custom Bullets

Nested Lists

Interactive Lists

Checklists

list

Lists represent ordered or unordered collections of items. Items can contain rich inline content and nested lists.

List types

Mechdown supports:

  • Unordered lists, prefixed with -

  • Ordered lists, prefixed with 1., 2., etc.

  • Custom bullet lists, prefixed with -(symbol)

  • Checklist items, prefixed with -[ ] and -[x]

Basic examples

Unordered List

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

  • Item 2

  • Item 3

Ordered List

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

  2. Second

  3. Third

Custom Start Number

To start an ordered list at a specific number, set the first item to that number.

7. Alpha
8. Beta
9. Gamma
  1. Alpha

  2. Beta

  3. Gamma

Custom Bullets

Mechdown supports custom bullet symbols using the syntax -(symbol), where the symbol can be any valid Unicode character or emoji.

-(🦜) Parrot
-(🏴‍☠️) Pirate
-(🐷) Pig
  • Parrot

  • Pirate

  • Pig

Nested Lists

Lists can be nested to any depth by indenting child items with at least two spaces. Sub lists can be any valid list type.

- Parent Item
   - Child Item 1
   - Child Item 2
      1. Subchild 1
      2. Subchild 2
- Another Parent
   -(⭐) Starred Child
   -(🌟) Another Starred Child

Interactive Lists

Mechdown supports various interactive list types that can be used for task tracking, checklists, and more.

Checklists

-[ ] Write docs
-[x] Add examples
-[ ] Review
  • Write docs

  • Add examples

  • Review