How to Markdown - IP-2025/waves-of-the-fallen GitHub Wiki

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Horizontal Lines

Bold Text
Bold Text

Italic Text
Italic Text

Bold and Italic
Bold and Italic

Strikethrough Text

Lists

Unordered List

  • Item 1
  • Item 2
    • Sub-item 1
    • Sub-item 2

Ordered List

  1. First item
  2. Second item
    1. Sub-item 1
    2. Sub-item 2

Links and Images

Clickable Link

Alt Text (Images)

Blockquotes

This is a blockquote.
Another line in the quote.

Code

Inline Code

Inline code

Code Block

print("Hello, Markdown!")

Tables

Name Age Country
John 25 USA
Alice 30 Canada
  • Task 1 (Done)
  • Task 2 (Pending)
  • Task 3 (Pending)

 

Style Guide

1. Structure & Headings

  • Use only one H1 (#) heading
  • Always start with an H1 (#) as the main title.
  • Use sequential headings (H2 > H3) to create a clear hierarchy.
  • Leave a blank line before and after headings for better readability.

2. Text Formatting

  • Use **bold** for emphasis and *italic* for subtle highlights.
  • Avoid excessive formatting (e.g., using ***bold and italic*** unnecessarily).

3. Lists

  • Use - for unordered lists and 1. for ordered lists.
  • Leave a blank line before and after lists.
  • Indent nested lists with two spaces.

4. Links & Images

  • Use descriptive link text instead of raw URLs.
  • Add alternative text (alt text) to images.

5. Code Blocks

  • Use inline code (\inline code``) for short snippets.
  • Use triple backticks (```) for multi-line code and specify the language.

6. Tables

  • Align columns properly using | and ---.
  • Keep table widths consistent.

7. Blockquotes

  • Use > for quotes and keep them short.

8. Task Lists

  • Use - [ ] for tasks and - [x] for completed items.

9. Horizontal Lines

  • Use ---, ***, or ___ for section breaks.

10. Special Characters

  • Escape special characters using \ when necessary.

Summary

  • Consistency is key – keep formatting clean and structured.
  • Whitespace improves readability – use blank lines where needed.
  • Use proper syntax – stick to Markdown standards for best compatibility.