Documentation Format

Markdown Guide

Markdown is a lightweight markup language that lets you format text using simple, readable syntax. It's widely used for documentation, README files, and content creation.

View Syntax Try Live Editor

What is Markdown?

Markdown is a plain text formatting syntax created by John Gruber in 2004. It's designed to be easy to read and write, and it converts seamlessly to HTML. Unlike rich text editors, Markdown uses simple symbols to format text.

Easy to Learn

Simple syntax that you can master in minutes

Plain Text

Works in any text editor, version control friendly

Converts to HTML

Renders beautifully on websites and apps

Basic Syntax

Master these fundamental Markdown elements to format your content effectively.

Headings

# Heading 1

Largest heading

## Heading 2

Second level heading

### Heading 3

Third level heading

Text Formatting

**bold text**

Makes text bold

*italic text*

Makes text italic

~~strikethrough~~

Strikethrough text

`inline code`

Inline code formatting

Lists

- List item

Unordered list item

* List item

Alternative unordered list

1. List item

Ordered list item

- [ ] Task

Checkbox (unchecked)

Links & Images

[Link text](url)

Create a hyperlink

![Alt text](image-url)

Embed an image

[Link][ref]

Reference-style link

Advanced Features

Take your Markdown to the next level with these powerful features.

Code Blocks

Create syntax-highlighted code blocks

```javascript
const hello = "world";
```

Blockquotes

Add quoted text or callouts

> This is a quote
> Multiple lines supported

Tables

Create formatted tables

| Name | Age |
|------|-----|
| John | 30  |

Horizontal Rules

Add horizontal divider lines

---

Try It Yourself

Edit the Markdown on the left and see the preview on the right.

Hello Markdown!

This is bold and this is italic text.

Features

Easy to write
Easy to read
Converts to HTML

Learn more

Using Markdown in Editors

Tips for writing Markdown in various editors and platforms.

Best Practices

Use the preview panel to see formatted output in real-time

Markdown is plain text, so it works in any text editor

Learn the basics first, then gradually add advanced syntax

Most editors support keyboard shortcuts for common formatting

Use consistent spacing and indentation for better readability

Keep paragraphs separated by blank lines

Desktop Editors

• VS Code
• Typora
• Obsidian
• Notion

Online Editors

• GitHub
• StackEdit
• Dillinger
• HackMD

Mobile Apps

• iA Writer
• Bear
• Drafts
• Markdown Pro

Common Markdown Cheatsheet

Element	Markdown Syntax
Heading 1	# Heading
Heading 2	## Heading
Bold	bold text
Italic	italic text
Link	[title](url)
Image	![alt](image.jpg)
Unordered List	- Item
Ordered List	1. Item
Code	`code`
Code Block	```code```

Start Using Markdown Today

Markdown is supported across BizKitHub platform. Use it for documentation, notes, emails, and more.

View API Docs More Guides