Headings
Markdown
# Heading 1
## Heading 2
### Heading 3Preview
Quick reference
Markdown cheatsheet
The syntax you will use most often. Each preview uses the same renderer as the editor.
Text and document structure
Start with the building blocks for readable Markdown documents.
Emphasis
Markdown
**Bold text**
*Italic text*
~~Strikethrough~~Preview
Bold text
Italic text
Strikethrough
Links and images
Markdown
[Markdown Lens](https://markdownlens.ayushdev.com)
Preview
Markdown Lens (opens in a new tab)
Remote image blocked from example.com (Alt text)
Blockquotes
Markdown
> Markdown keeps plain text readable.
>
> Add another line with the same marker.Preview
Markdown keeps plain text readable.
Add another line with the same marker.
Lists and tasks
Use indentation to create hierarchy and square brackets to track work.
Ordered and unordered lists
Markdown
- First item
- Second item
- Nested item
1. Plan
2. Write
3. ReviewPreview
- First item
- Second item
- Nested item
- Plan
- Write
- Review
Task lists
Markdown
- [x] Draft the README
- [ ] Add examples
- [ ] Request reviewPreview
- Draft the README
- Add examples
- Request review
Tables
Separate headers with dashes and columns with vertical bars.
Feature table
Markdown
| Feature | Status |
| --- | ---: |
| Tables | Ready |
| Mermaid | Ready |
| Math | Ready |Preview
| Feature | Status |
|---|---|
| Tables | Ready |
| Mermaid | Ready |
| Math | Ready |
Code
Use backticks for inline code and triple backticks for fenced blocks.
Inline code
Markdown
Run `npm run dev` to start the app.Preview
Run npm run dev to start the app.
Fenced code block
Markdown
```ts
const greeting = "Hello, Markdown!";
console.log(greeting);
```Preview
const greeting = "Hello, Markdown!";
console.log(greeting);
Mermaid diagrams and math
Markdown Lens recognizes Mermaid fences and KaTeX-compatible math delimiters.
Mermaid diagram
Markdown
```mermaid
flowchart LR
A[Write] --> B[Preview]
B --> C[Publish]
```Preview
Mermaid diagram is paused until you choose to render it.
Inline and block math
Markdown
Inline: $E = mc^2$
Block:
$$
\int_0^1 x^2\,dx = \frac{1}{3}
$$Preview
Inline:
Block:
Ready to try it?
Open an example above to edit it, or start from a file.