Github Markdown Syntax

This guide is based on Writing on GitHub - Github Help.

Heading

The largest heading

The second largest heading

The smallest heading (the sixth largest heading)

Styling text

Blod, Italic, ~~Strikethrough~~, Bold and italic.

Quoting text

Before quote:

Quote

After quote.

Syntax highlight

Use inline code and block code:

#include <iostream>
using namespace std;
int main(int argc, char * argv[]) {
  cout << "Hello world" << endl;
  return 0;
}

Lists

Unordered lists

list item
list item
list item

Ordered lists

list item
list item
list item

Nested lists

list item
- list item
  - list item

list item
1. list item
  1. list item
list item
- list item
  1. list item

Task lists

list item
unchecked list item
checked list item

Tables

table header	left aligned	center aligned	right aligned
table row	table data	table data	table data
table row	table data	table data	table data
very long, very very long	very long, very very long	very long, very very long	very long, very very long

Paragraphs and line breaks

First paragraph first sentence. First paragraph second sentence.

Second paragraph.

Ignore Markdown formatting

Use \.

Invalid in GitHub Pages

Autolink

URLs: https://github.com/

Mention people and teams: @centixkadon

Reference issues and pull requests: #number or username/repository#number

Emoji

:EMOJICODE:, e.g. :+1:, :shipit:. Check out emoji cheat sheet.

kramdown

Math

a ^ 2 = 3

a ^ 2 = 3

\begin{aligned} & \phi(x,y) = \phi \left(\sum_{i=1}^n x_ie_i, \sum_{j=1}^n y_je_j \right) = \sum_{i=1}^n \sum_{j=1}^n x_i y_j \phi(e_i, e_j) = \\ & (x_1, \ldots, x_n) \left( \begin{array}{ccc} \phi(e_1, e_1) & \cdots & \phi(e_1, e_n) \\ \vdots & \ddots & \vdots \\ \phi(e_n, e_1) & \cdots & \phi(e_n, e_n) \end{array} \right) \left( \begin{array}{c} y_1 \\ \vdots \\ y_n \end{array} \right) \end{aligned}