GitHub Flavored Markdown Guide

GitHub Flavored Markdown (GFM) extends standard Markdown with additional features. Here are the key elements and examples:

Basic Syntax

Headers

H1 Header

H2 Header

H3 Header

Emphasis

Italic text or italic text Bold text or bold text Bold and italic or bold and italic

Lists

Ordered List:

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

Unordered List:

• Item one
• Item two
  • Nested item
  • Another nested item
• Item three

Links and Images

Visit GitHub

GFM Special Features

Task Lists

• Completed task
• Incomplete task
• Another task

Tables

Code Blocks

function hello() {
  console.log("Hello, World!");
}

Strikethrough

Strikethrough text

Emoji

:smile: :heart: :thumbsup:

Mentions and References

@username #issue_number

Automatic Links

http://example.com

Footnotes

Here's a sentence with a footnote¹.

Extended Formatting

Blockquotes

This is a blockquote

Nested blockquote

Horizontal Rule

Escaping Characters

*Not italic* `Not code`

Remember that GFM is compatible with standard Markdown while adding these extra features for enhanced documentation and collaboration on GitHub.

math

This sentence uses $ delimiters to show math inline: $\sqrt{x-1}+(1+x)^2$

The Cauchy-Schwarz Inequality\

$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$