RoboDOJO

Why Markdown?
Markdown Syntax
Different Flavors of Markdown

Lists

Lists are essential for organizing information in Markdown. Learn how to create ordered, unordered, and nested lists effectively.

Unordered Lists

Use -, *, or + to create bullet points:

MARKDOWN
- First item
- Second item
- Third item

Result:

  • First item
  • Second item
  • Third item

Alternative Bullet Styles

All these create the same result:

MARKDOWN
- Item with asterisk

* Item with plus

- Item with dash

Result:

  • Item with asterisk
  • Item with plus
  • Item with dash

💡 Tip: Choose one style and stick with it throughout your document for consistency.

Ordered Lists

Use numbers followed by periods:

MARKDOWN
1. First step
2. Second step
3. Third step

Result:

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

Auto-numbering

Markdown automatically numbers your lists:

MARKDOWN
1. First item
1. Second item (still becomes 2)
1. Third item (still becomes 3)

Result:

  1. First item
  2. Second item (still becomes 2)
  3. Third item (still becomes 3)

Starting with Different Numbers

MARKDOWN
5. Start at five
6. Continue sequence
7. Keep going

Result: 5. Start at five 6. Continue sequence 7. Keep going

Nested Lists

Simple Nesting

Indent with 2-4 spaces to create nested lists:

MARKDOWN
- Main item
  - Sub item
  - Another sub item
- Another main item
  - Sub item
    - Sub-sub item
    - Another sub-sub item

Result:

  • Main item
    • Sub item
    • Another sub item
  • Another main item
    • Sub item
      • Sub-sub item
      • Another sub-sub item

Mixed List Types

Combine ordered and unordered lists:

MARKDOWN
1. First main point
   - Supporting detail
   - Another detail
2. Second main point
   - More details
     1. Numbered sub-detail
     2. Another numbered detail
3. Third main point

Result:

  1. First main point
    • Supporting detail
    • Another detail
  2. Second main point
    • More details
      1. Numbered sub-detail
      2. Another numbered detail
  3. Third main point

Advanced List Features

Lists with Multiple Paragraphs

Add content to list items with proper indentation:

MARKDOWN
1. First item with multiple paragraphs.

   This is the second paragraph of the first item.

   And this is a third paragraph.

2. Second item with a blockquote:

   > This is a blockquote
   > inside a list item.

3. Third item with code:

   ```javascript
   console.log("Code in a list!");
   ```
CODE

**Result:**
1. First item with multiple paragraphs.

   This is the second paragraph of the first item.

   And this is a third paragraph.

2. Second item with a blockquote:

   > This is a blockquote
   > inside a list item.

3. Third item with code:

   ```javascript
   console.log('Code in a list!');

Task Lists (GitHub Flavored Markdown)

Create interactive checkboxes:

MARKDOWN
- [x] Completed task
- [ ] Incomplete task
- [x] Another completed task
- [ ] Another incomplete task

Result:

  • Completed task
  • Incomplete task
  • Another completed task
  • Another incomplete task

Practical Examples

Project Planning

MARKDOWN
## Sprint Planning

### Completed ✅

- [x] Set up development environment
- [x] Create project repository
- [x] Design initial wireframes

### In Progress 🔄

- [ ] Implement user authentication
  - [x] Set up login form
  - [x] Create user model
  - [ ] Add password validation
  - [ ] Implement session management

### Planned 📋

- [ ] Build dashboard
- [ ] Add data visualization
- [ ] Implement notifications

Tutorial Steps

MARKDOWN
# Getting Started with React

## Prerequisites

Before starting, make sure you have:

1. **Node.js** installed (version 16+)
   - Download from [nodejs.org](https://nodejs.org)
   - Verify installation: `node --version`

2. **Package manager** of choice:
   - npm (comes with Node.js)
   - yarn: `npm install -g yarn`
   - pnpm: `npm install -g pnpm`

3. **Code editor** (recommended):
   - VS Code with React extensions
   - WebStorm
   - Sublime Text

## Setup Steps

1. Create a new React app:
   ```bash
   npx create-react-app my-app
   cd my-app
   ```

  1. Start the development server:

    npm start

  2. Open your browser and navigate to:

  3. Begin development:

    • Edit src/App.js
    • Save changes to see live updates
    • Use browser dev tools for debugging
CODE

### Feature Comparison
```markdown
## Framework Comparison

### React
**Pros:**
- Large ecosystem
- Strong community support
- Flexible architecture
- Great developer tools

**Cons:**
- Steep learning curve
- Frequent updates
- Need additional libraries for full features

### Vue.js
**Pros:**
- Easy to learn
- Great documentation
- Progressive adoption
- Built-in state management

**Cons:**
- Smaller ecosystem than React
- Less job market demand
- Fewer third-party components

### Angular
**Pros:**
- Full framework solution
- TypeScript by default
- Powerful CLI tools
- Enterprise-ready

**Cons:**
- Very steep learning curve
- Heavy and complex
- Frequent breaking changes

Best Practices

1. Consistent Indentation

Use consistent spacing (2 or 4 spaces):

✅ Good:

MARKDOWN
- Main item
  - Sub item (2 spaces)
  - Another sub item (2 spaces)

❌ Inconsistent:

MARKDOWN
- Main item
  - Sub item (3 spaces)
  - Another sub item (2 spaces)

2. Logical Grouping

Group related items together:

✅ Well organized:

MARKDOWN
## Development Tools

### Code Editors

- VS Code
- WebStorm
- Sublime Text

### Version Control

- Git
- GitHub
- GitLab

### Package Managers

- npm
- yarn
- pnpm

3. Meaningful Content

Make list items descriptive:

✅ Descriptive:

MARKDOWN
- Install Node.js version 16 or higher
- Clone the repository to your local machine
- Run `npm install` to install dependencies

❌ Vague:

MARKDOWN
- Install Node
- Clone repo
- Install stuff

Common Mistakes

1. Incorrect Indentation

❌ Wrong:

MARKDOWN
- Main item
- Sub item (should be indented)

✅ Correct:

MARKDOWN
- Main item
  - Sub item (properly indented)

2. Missing Spaces

❌ Wrong:

MARKDOWN
-Item without space
1.Numbered item without space

✅ Correct:

MARKDOWN
- Item with space

1. Numbered item with space

3. Inconsistent Markers

❌ Inconsistent:

MARKDOWN
- First item

* Second item

- Third item

✅ Consistent:

MARKDOWN
- First item
- Second item
- Third item

Platform-Specific Features

GitHub

  • Task lists with checkboxes
  • Automatic issue/PR linking
  • Emoji support in lists

GitLab

  • Similar to GitHub
  • Task list progress tracking
  • Weight and assignee support

Notion

  • Toggleable list items
  • Different bullet styles
  • Drag and drop reordering

Accessibility Tips

Screen Reader Friendly

  • Use semantic list structures
  • Keep items concise and clear
  • Avoid overly nested lists (max 3-4 levels)

Visual Clarity

MARKDOWN
## Clear List Structure

### Main Categories

1. **Category A**: Description
   - Sub-item with details
   - Another sub-item

2. **Category B**: Description
   - Important sub-item
   - Secondary sub-item

Quick Reference

List TypeSyntaxExample
Unordered- item- item
Ordered1. item1. item
Task- [ ] task- [ ] task
Completed- [x] done- [x] done

Lists are the backbone of organized content – use them to make your information scannable and actionable!