BuildUtilities

Markdown Syntax Guide

What is Markdown?

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. It's used extensively on GitHub, documentation sites, blogs, and note-taking apps. Files typically use the .md extension.

Basic Formatting

# Heading 1
## Heading 2
### Heading 3

**bold text**
*italic text*
~~strikethrough~~
`inline code`

> Blockquote

---  (horizontal rule)

Links & Images

[Link text](https://example.com)
[Link with title](https://example.com "Title")

![Alt text](image.png)
![Alt text](image.png "Optional title")

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Second item
   1. Nested ordered

- [x] Task completed
- [ ] Task pending

Code Blocks & Tables

```javascript
const greeting = "Hello, World!";
console.log(greeting);
```

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

GitHub-Flavored Markdown Extras

  • Task lists: - [x] and - [ ]
  • Syntax-highlighted code blocks: specify language after backticks
  • Autolinked references: #123 links to issues, @user mentions
  • Footnotes: [^1] for reference notes

Preview your Markdown in real-time with our Markdown Preview tool.

FAQ

Markdown vs HTML, when to use which?

Use Markdown for content writing and documentation. Use HTML when you need precise layout control, custom styling, or interactive elements.

Can I use HTML inside Markdown?

Yes, most Markdown renderers allow inline HTML. Useful for adding attributes, videos, or complex layouts within Markdown files.

Try These Tools

Related Documentation

Tip Jar