Markdown List Generator

About Markdown Lists

Markdown supports three types of lists: unordered (bullets), ordered (numbers), and task lists (checkboxes).

Unordered Lists

Use hyphens (-), asterisks (*), or plus signs (+) for bullet points:

- First item
- Second item
- Third item

All three markers work identically. Choose one and be consistent.

Ordered Lists

Use numbers followed by periods:

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

Pro tip: You can use 1. for all items, and markdown will auto-number them correctly.

Task Lists

GitHub and many platforms support task lists with checkboxes:

- [ ] Unchecked task
- [x] Checked task
- [ ] Another task

Note: There must be a space between the brackets [ ].

Nested Lists

Indent sub-items with 2-4 spaces or 1 tab:

- Main item
  - Sub-item 1
  - Sub-item 2
    - Nested sub-item
- Another main item

Mixed Lists

You can mix ordered and unordered lists:

1. First step
   - Sub-point A
   - Sub-point B
2. Second step
   - Sub-point C

List Best Practices

• Consistency: Use the same marker throughout (-, *, or +)
• Spacing: Add blank lines between list and other content
• Indentation: Use 2 or 4 spaces consistently for nesting
• Parallel structure: Keep list items grammatically similar
• Length: Keep list items concise

Task List Features

• GitHub/GitLab: Checkboxes are clickable in issues and PRs
• Progress tracking: Shows completion percentage
• Interactive: Check/uncheck without editing markdown
• Nested tasks: Create hierarchical todo lists

Common Use Cases

• Documentation: Feature lists, requirements, steps
• README files: Features, installation steps, usage
• Project management: Todo lists, checklists
• Notes: Bullet points, outlines
• Comparison: Pros/cons, alternatives

Paragraphs in Lists

Add paragraphs within list items by indenting:

1. First item

   This is a paragraph within the first item.

2. Second item

   - Nested list within second item
   - Another nested item

Code in Lists

Include code blocks within lists by indenting further:

1. Install the package

   ```bash
   npm install package-name
   ```

2. Import it

   ```javascript
   import pkg from 'package-name';
   ```