69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
Markdown is an easy-to-use formatting language for creating structured documents. It is also a platform agnostic language; any documents you write in markdown are compatible with nearly any text editor. Here's how to use some common Markdown elements:
|
|
## Headings
|
|
|
|
Create headings by using hashtags (#) at the start of a line:
|
|
# Heading 1
|
|
## Heading 2
|
|
### Heading 3
|
|
|
|
The more hashtags, the smaller the heading.
|
|
## Text Formatting
|
|
|
|
- Make text *italic* by surrounding it with single asterisks: `*italic*`
|
|
- Make text **bold** by surrounding it with double asterisks: `**bold**`
|
|
- Create ~~strikethrough~~ text with double tildes: `~~strikethrough~~`
|
|
## Lists
|
|
|
|
### Unordered Lists
|
|
|
|
Use a dash (-), asterisk (*), or plus (+) for bullet points:
|
|
|
|
- Item 1
|
|
- Item 2
|
|
- Subitem 2.1
|
|
- Subitem 2.2
|
|
|
|
### Ordered Lists
|
|
|
|
Use numbers followed by periods for ordered lists:
|
|
|
|
1. First item
|
|
2. Second item
|
|
3. Third item
|
|
|
|
## Links
|
|
Create a link by putting the link text in square brackets followed by the URL in parentheses:
|
|
|
|
`[name of file](link to file)`
|
|
|
|
[Visit Google](https://www.google.com)
|
|
|
|
## Images
|
|
Add images similarly to links, but with an exclamation mark at the start:
|
|
|
|
``
|
|
|
|
|
|
|
|
## Quotes
|
|
Use a greater-than sign (>) to create block quotes:
|
|
|
|
> This is a block quote. It can span multiple lines.
|
|
|
|
## Code
|
|
For inline code, use single backticks: `code here`
|
|
|
|
For code blocks, use triple backticks:
|
|
|
|
```
|
|
function example() {
|
|
console.log("Hello, world!");
|
|
}
|
|
```
|
|
|
|
## Horizontal Lines
|
|
Create a horizontal line with three or more hyphens, asterisks, or underscores:
|
|
|
|
---
|
|
|
|
That's it! You now know the basics of Markdown formatting. |