Markdown is a lightweight markup language that allows you to format text using simple, intuitive syntax. It's perfect for writing documentation, README files, blog posts, and more. This guide will teach you the fundamentals of markdown in just a few minutes.
Markdown is a text-to-HTML conversion tool that lets you write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid HTML. Created by John Gruber in 2004, markdown has become the standard for writing documentation and formatted text on the web.
Markdown is everywhere in the modern web development and writing world:
Headers create document structure. Use # symbols to create different header levels:
# Heading 1 (Largest)
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6 (Smallest)
Always put a space after the # symbol. #Header won't work, but # Header will.
Make text bold, italic, or strikethrough:
**bold text** or __bold text__
*italic text* or _italic text_
***bold and italic*** or ___bold and italic___
~~strikethrough text~~
Create ordered and unordered lists:
- Item one
- Item two
- Item three
* Alternative bullet
* Another item
+ Another option
+ Final item
1. First item
2. Second item
3. Third item
- Main item
- Sub-item one
- Sub-item two
- Another main item
1. Numbered sub-item
2. Another numbered sub-item
Create links to websites and other resources:
[Link text](https://example.com)
[Link with title](https://example.com "Title text")
[Link text][reference]
[Another link][ref2]
[reference]: https://example.com
[ref2]: https://example.com "Optional title"
Add images similar to links, but with an exclamation mark:


Display code inline or in blocks:
Use `backticks` for inline code.
```
function example() {
return "Hello, World!";
}
```
```javascript
function example() {
return "Hello, World!";
}
```
Quote text using the > symbol:
> This is a blockquote.
> It can span multiple lines.
>
> You can have multiple paragraphs.
Create visual separators:
---
***
___
Create tables using pipes and dashes:
| Column 1 | Column 2 | Column 3 |
|----------|:--------:|---------:|
| Left | Center | Right |
| Data | Data | Data |
The colons (:) in the separator row control alignment: left (default), center (:---:), or right (---:).
Control line breaks in your text:
Line one
Line two (single line break)
Line three (double line break creates paragraph)
Two spaces at the end of a line create a hard line break. A blank line creates a new paragraph.
README files are the perfect place to start using markdown. They're used on GitHub, GitLab, and other platforms to document projects:
# My Awesome Project
## Description
This is a brief description of my project.
## Installation
1. Clone the repository
2. Install dependencies
3. Run the application
## Usage
```bash
npm start
```
## Contributing
Contributions are welcome! Please read the [contributing guide](CONTRIBUTING.md).
Markdown is perfect for writing technical documentation:
Many blogging platforms support markdown, making it easy to write formatted posts without HTML knowledge.
Ready to start writing markdown? Here's how:
Now that you understand the basics, explore our other guides: