Markdown Basics

Learn the basic syntax supported by this editor. Copy the examples into the workspace to practice and see the results immediately.

Headings

Start a line with # followed by a space. More hashes create deeper heading levels.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Use one level-one heading for the document title, then organize sections with level-two headings.

Paragraphs and line breaks

Separate paragraphs with a blank line.

This is the first paragraph.

This is the second paragraph.

To insert a line break within a paragraph, add two spaces before pressing Enter.

Emphasis

*Italic*
**Bold**
***Bold and italic***
~~Deleted text~~

Result: Italic, Bold, Bold and italic, Deleted text.

Lists

Bullet lists

- Apple
- Banana
  - Small banana
  - Large banana

Numbered lists

1. Prepare content
2. Write the document
3. Check the preview

Indent nested items by two or four spaces.

Task lists

- [x] Completed task
- [ ] Pending task

Result:

• Completed task
• Pending task

Blockquotes

Start a paragraph with > to create a quotation.

> Writing helps organize your thoughts.

Result:

Writing helps organize your thoughts.

Links and images

Put link text in square brackets and the address in parentheses. Add ! before a link to display an image. Use a local site path or an address you control.

[Read the project notes](./README.md)
![Image description](./images/example.png)

The image description remains available if the image cannot load. Choose text that accurately describes the image.

Horizontal rules

Place three or more hyphens on their own line to separate sections.

First section

---

Second section

Inline code

Wrap commands, filenames or variables in backticks.

Run `npm run build` to build the project.

Result: Run npm run build to build the project.

Code blocks

Wrap multiple lines of code in triple backticks. Add a language name after the opening fence to enable syntax highlighting.

```javascript
function add(left, right) {
  return left + right
}
```

Result:

function add(left, right) {
  return left + right
}

Tables

Separate columns with pipes and use hyphens on the second line for the header. Colons control alignment.

| Item | Status | Count |
| :--- | :---: | ---: |
| Documents | Done | 3 |
| Examples | In progress | 1 |

Result: