The Markdown syntax is how we format text. A markdown file ends with the .md
or .markdown
extension. Before we get into it, let's make a new repository on GitHub.
After you login, click on the "New" green button on the left to create a new repository.






Heading
Headings range from 1 to 5, with 1 being the largest and 5 the smallest. To write a line of heading, we add #
before the text.
Markdown | Output |
---|---|
# Heading 1 |
Heading 1 |
## Heading 2 |
Heading 2 |
### Heading 3 |
Heading 3 |
#### Heading 4 |
Heading 4 |
##### Heading 5 |
Heading 5 |
Emphasis
To emphasize text, we can use bold, italics or strike.
Markdown | Output |
---|---|
**bold** |
bold |
_italics_ |
italics |
~strike~ |
Lists
Markdown allows you to have three kinds of list.
Ordered Lists
Markdown | Output |
---|---|
1. One 2. Two 3. Three |
|
Unordered Lists
Markdown | Output |
---|---|
- One - Two - Three |
|
Indents and Combination
Ordered and Unordered lists can be combined, along with indentation with tabs to create nested lists.
Markdown | Output |
---|---|
1. One 2. Two - Nest 1 - Nest 2 |
|
Links
Markdown allows to reference external and internal (repo) images and files.
Images
The syntax for adding images is 
Internal
Markdown | Output |
---|---|
 |
![]() |
External
Markdown | Output |
---|---|
 |
![]() |
Files
The syntax for referencing files is [Description Name](file Link)
Internal
Markdown | Output |
---|---|
[File Name](folder/file.txt) |
File Name |
External
Markdown | Output |
---|---|
[Batch Apex](https://github.com/Admin2Dev/apex-snippets/blob/master/batch/README.md) |
Batch Apex |
Code
There are two ways to mark a block of text as code in markdown.
Markdown | Output |
---|---|
`single line` | single line |
``` multi line code ``` |
|
Table
Creating tables in markdown can get confusing (and irritating) at times, so it's much easier to use a service like Markdown Table Generator and paste in the code.
Chapter 5: Using Git