Markdown is a way to style text on the web. You control the display of the document formating words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown.

This Markdown guide provides an overview of all the Markdown syntax elements. If you need more information about any of these elements, refer to our reference guides for basic syntax and extended syntax .

Also we will see the GFMD sintax its github.com own version of the Markdown syntax, that provides an additional set of useful features, many of which make it easier to work with content on github.com. For more complete info, see John Gruber's original spec and the Github-flavored Markdown page or Writing on GitHub .

Headers

# H1
## H2
## H3
### H4
#### H5
#### H6

Alternatively, for H1 and H2, an underline-ish style:

Alternative-H1
======

Alternative-H2
------

H1

H2

H3

H4

H5

H6

Alternatively, for H1 and H2, an underline-ish style:

Alternative-H1

Alternative-H2

Emphasis

This text will be bold is done using **This text will be bold** This will also be bold is done using __This will also be bold__

This text will be italic is done using *This text will be italic* This will also be italic is done using _This will also be italic_

~~The text will be strikethrough~~ is done using ~~The text will be strikethrough~~

*You can also combine them*

Lists

Unordered

Adding a - will change it into a list:

- Item 1
- Item 2
  - Item 2a
- Item 3

Item 1
Item 2
- Item 2a
Item 3

Adding a * will change it into a list:

* Item 1
* Item 2
  * Item 2a
* Item 3

Item 1
Item 2
- Item 2a
Item 3

Ordered

Adding a - will change it into a list:

1. Item 1
2. Item 2
  a. Item 2a
3. Item 3

Item 1
Item 2 a. Item 2a
Item 3

Task Lists

- [x] Complete Item
- [ ] Incomplete Item
- [x] #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)

Complete Item
Incomplete Item
#refs, [links](), formatting, and ~~tags~~ supported
list syntax required (any unordered or ordered list supported)

Links

GFMD will automatically detect URL and convert them to links like this https://www.toncho.dev
To specify a link on a text, do this:

This is [an example](https://toncho.dev/ "Title") inline link.
[This link](https://toncho.dev/) has no title attribute.

This is an example inline link. This link has no title attribute.

Relative Links

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

[Markdown Guide](markdown/markdown-guide)

Markdown Guide

Escape sequence

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formating syntax.

Markdown provides backslash escapes for the following characters:

\ backslash ` backtick * asterisk _ underscore {} curly braces [] square brackets () parentheses # hash mark + plus sign - minus sign (hyphen) . dot ! exclamation mark

You can escape using \ eg. \`

Quoting

You can create a quote using >:

> This is a quote

This is a quote

Horizontal Rules

Horizontal rule is created using --- on a line by itself.

Coding - Block

```javascript
function someTest() {
  // do some stuff
 console.log("do something");
}
```

function someTest() {
  // do some stuff
 console.log("do something");
}

Note: You can specify the different syntax highlighting based on the coding language eg. javascript, sh, php, etc

Coding - In-line

You can produce inline-code by using only one ` to enclose the code:

This is some code: `echo something`

This is some code: echo something

Table

These can be created via HTML or you can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |

<table>
  <tr>
    <th>ID</th><th>Name</th>
  </tr>
  <tr>
    <td>1</td><td>Alton Bell Smythe</td>
  </tr>
  <tr>
    <td>2</td><td>Someone else</td>
  </tr>
</table>

ID	Name
1	Alton Bell Smythe
2	Someone else

ID | Name
------------ | -------------
1 | Alton Bell Smythe
2 | Someone else

ID	Name
1	Alton Bell Smythe
2	Someone else

Definition list

These can be created via HTML or you can create definition tables by assembling a list of words and dividing them with colon :

<dl>
  <dt>Term</dt>
  <dd>Definition</dd>
  <dt>Another Term</dt>
  <dd>Another Definition</dd>
</dl>

Term: Definition
Another Term: Another Definition

Term
: Definition

Another Term
: Another Definition

Term: Definition
Another Term: Another Definition

Adding Image

![Lorem Image](https://picsum.photos/400/300?City "City")

Lorem Image

Issue References

Any number that refers to an Issue or Pull Request will be automatically converted into a link. You can bring up a list of suggested Issues and Pull Requests within the repository by typing #.

#1 test#1 abellsmythe/test#1

Username @mentions

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

@abellsmythe

@abellsmythe

Emoji

GitHub supports emoji!

🎉 🚀 🤘

🎉 🚀 🤘

Note: To see a list of every image we support, check out emoji-cheat-sheet