Markdown Syntax - treenabalds/How-To GitHub Wiki

Could you provide a list of basic Markdown keystrokes? (Or whatever they are called.)

Sure! In Markdown, you use syntax (not really keystrokes) to format text. Here's a list of some basic Markdown syntax you can use for documentation:

Text Formatting

  • Bold: **text** or __text__ → text
  • Italic: *text* or _text_ → text
  • Strikethrough: ~~text~~ → text

Headings

  • Use # symbols for headings:
    • # Heading 1
    • ## Heading 2
    • ### Heading 3

Lists

  • Unordered list: Use -, *, or +
    • - Item 1
    • - Item 2
  • Ordered list: Use numbers followed by a period
    • 1. Item 1
    • 2. Item 2

Links and Images

  • Link: [link text](URL) → link text
  • Image: ![alt text](image_url) → alt text

Code

  • Inline code: Use backticks: `code` → code
  • Code block: Use triple backticks: 
    ```
Code block
```

Blockquotes

  • Use > to create blockquotes:

    This is a blockquote.

Horizontal Rule

  • Use ---, ***, or ___ to create a horizontal rule:

Tables

  • Use | to create tables: 
    | Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |

This will display as:

Header 1 Header 2
Cell 1 Cell 2

Markdown is versatile and great for clean, lightweight documentation. Let me know if you'd like to dive deeper into any of these features!