Basic writing and formatting syntax
March 7, 2022
8:06 AM
Headings
To create a heading, add one to six # symbols before your heading text. The number of # you use will determine the size of the heading.
# The largest heading
## The second largest heading
###### The smallest heading
From <[link]> 
Styling text
You can indicate emphasis with bold, italic, or strikethrough text in comment fields and .md files.
Style
Syntax
Keyboard shortcut
Example
Output
Bold
Command+B (Mac) or Ctrl+B (Windows/Linux)
**This is bold text**
This is bold text
Italic
Command+I (Mac) or Ctrl+I (Windows/Linux)
*This text is italicized*
This text is italicized
Strikethrough
~~ ~~
~~This was mistaken text~~
This was mistaken text
Bold and nested italic
**This text is _extremely_ important**
This text is extremely important
All bold and italic
*** ***
***All this text is important***
All this text is important
From <[link]> 
Quoting text
You can quote text with a >.
Text that is not a quote

> Text that is a quote
From <[link]> 
Quoting code
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted. You can also press the Command+E (Mac) or Ctrl+E (Windows/Linux) keyboard shortcut to insert the backticks for a code block within a line of Markdown.
Use `git status`to list all new or modified files that haven't yet been committed.

To format code or text into its own distinct block, use triple backticks.
Some basic Git commands are:
```
git status
git add
git commit
```

From <[link]> 
Links
You can create an inline link by wrapping link text in brackets [ ], and then wrapping the URL in parentheses ( ). You can also use the keyboard shortcut Command+K to create a link. When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.
This site was built using [GitHub Pages]([link]).
From <[link]> 
Images
You can display an image by adding ! and wrapping the alt text in [ ]. Then wrap the link for the image in parentheses ().
![This is an image]([link])
From <[link]> 