What is Markdown?

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages. It is widely used for creating websites, documents, notes, books, presentations, email messages, and technical documentation.

How to Use a Markdown Editor with Live Preview

Write plain text on one side and check rendered output in real time. This helps you catch heading levels, code fences, lists, and links before publishing documentation.

Markdown in Practice

Markdown stays readable as plain text, keeps diffs small, and converts cleanly to HTML or PDF. It fits well for READMEs, changelogs, runbooks, notes, and any content that benefits from quick edits without heavy tooling.

• Version-control friendly: Plain text makes code-review and history clear.
• Portable: One source can be rendered on static sites, docs tools, and export pipelines.
• Keyboard-first: Formatting happens inline, so writing flow is fast.

Markdown Syntax

Headings

# H1
## H2
### H3

Emphasis

**bold** and *italic* and ~~strikethrough~~

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Second item
3. Third item

Links and Images

[Link text](https://example.com)
![Alt text](https://example.com/image.png)

Blockquotes

> Quoted line
> Another line

Inline Code and Fences

Use `inline code` inside text.

```js
function greet(name) {
  return `Hello, ${name}!`;
}
```

Footnotes

Here is a footnote reference.[^1]

[^1]: Footnote text.

Tables (GFM)

| Lang | Type    |
| ---- | ------- |
| JS   | Dynamic |
| Go   | Static  |

Task Lists (GFM)

- [x] Write outline
- [ ] Add examples
- [ ] Publish

Horizontal Rule

---

FAQ

Does this editor support GitHub Flavored Markdown?

Yes. You can use common GFM features like tables, task lists, and fenced code blocks.

Can I use this for README files?

Absolutely. It is useful for writing and reviewing README content before committing to your repository.

Is markdown better than rich text for technical docs?

For most engineering teams, markdown improves version control, review workflows, and long-term portability.