Add one to six # symbols efore the text. This corresponds to h1 - h6 and will determine the hierarchy level and typeface of the text.
# Heading 1
## Heading 2
### Heading 3
Styling Text
Bold text with ** or __ (Ex: **bolded text**, __bolded text__)
Italisize text with * or _ (Ex: *italic text*, or _italic text_)
Strikethrough text with ~~ (Ex: ~~strikethrough text~~)
Bold and Italic text with *** (Ex: ***bold and italic text***)
Bold text with nested Italic text (Ex: **bold text _italic text_**)
\ is an escape character for when you need to go to a new line
Quoting
Blockquote text with a > (Ex: > Blockquote text)
Quote code with ` (Ex: `code`)
Quote a block of code with ``` (Ex: ```block of code```). To close it add ``` to a new line. On github this will be copyable. You need a space below the blockquote text to escape it.
Links and Email Adresses
[Link Text](website.com)
Link text in markdown wont open in a new tab (boo) If you need to you can use HTML for a link or tell the user to right click.
On github you can use relative links to direct to other files in your repo. (Ex: linking to the contributing file in your readme might look liek this: [contributing.md](docs/contributing.md))
Link to an email address by wrapping the email in <> (Ex: <email@email.com>)
Images
Link to images by adding ! in front of the square brackets [] that will wrap the alt text and parenthases () that will wrap the image URL. (Ex: )
Add a docs folder with your image directory with any screenshots for the readme.
Open up file explorer and drag an image into the readme file and it will place the image HTML in it.
Lists
Make an unordered list by preceding text with - * or +.
Nest lists by adding spaces in front of the list marker character.
You can create task lists by prefacing each item with a - a pace and a square brackets [].
To mark a task as complete use x inside the brackets.
Example: * Fruit
- grapes
- apple
- [X] Banana
- [ ] Avacado
* Vegitables
- carrot
- asparagus
When writing markdown in VS Code hit ctrl + K to view what it will look like on github.
What To include in your Reademe
Title
Description (what app does, tech used, challenges and goals for improving in the future)
Table of contents -- github wll generate a table of contents if you view the readme file in the right corner. To link to different headings to #the-heading-title.