PlayTools

Markdown preview for docs, READMEs, and changelogs

左側編寫 Markdown,右側即時 HTML 預覽,支援完整 CommonMark 語法,全程在瀏覽器運行。

Runs in your browser — nothing you enter is uploaded
113 words702 chars
Markdown
Preview

Markdown preview for docs, READMEs, and changelogs

CommonMark reduces ambiguity vs older Markdown flavors, but tables, footnotes, and task lists still vary by renderer—preview before publishing to GitHub vs internal wikis.

Paste scrubbing: strip auth tokens from fenced code blocks before exporting HTML snapshots.

What the preview supports

The preview renders GitHub-Flavored Markdown (GFM) as you type: headings, emphasis, links, images, block quotes, ordered and unordered lists, inline code and fenced code blocks, horizontal rules, tables, task lists (- [ ] and - [x]), strikethrough (~~text~~) and automatic links for bare URLs.

Raw HTML is allowed — <kbd>, <sub>, <sup>, <details> and similar tags render as you would expect — but the output is sanitised, so scripts, event handlers such as onclick, and javascript: links are removed before anything is displayed. Copy HTML gives you that same sanitised markup, ready to paste into a CMS or an email template.

Syntax cheat sheet

# Heading 1 / ## Heading 2 / ### Heading 3
**bold**  *italic*  ~~strikethrough~~  `inline code`
[link text](https://example.com)
![alt text](https://example.com/photo.jpg)
> quoted text
- bullet item        1. numbered item
- [ ] open task      - [x] done task
---                  (horizontal rule)
| Column | Column |
| ---    | ---:   |   (:--- left, :---: centre, ---: right)
```js
code block with a language label
```

Mistakes that change the output

  • Missing blank lines: a list, table or heading directly after a paragraph line may be swallowed into the paragraph. Put a blank line before block elements.
  • Single line breaks: one newline inside a paragraph does not start a new line in GFM. End the line with two spaces or a backslash, or leave a blank line for a new paragraph.
  • Indentation in nested lists: sub-items must be indented to line up under the parent item’s text — two spaces after “- ”, three after “1. ”.
  • Underscores in words: snake_case_names are left alone in GFM, but *asterisks* in the middle of words still create emphasis. Wrap identifiers in backticks.
  • Pipes in tables: a literal | inside a table cell must be escaped as \|.

Where your Markdown will end up

GitHub, GitLab, VS Code, Obsidian and most static-site generators use GFM or a close relative, so what you see here is a reliable preview for README files, issues and documentation. Some platforms differ: Reddit and Discord support only a subset (Discord has no tables), Slack uses its own “mrkdwn” with *single asterisks* for bold, and Jira uses a separate wiki syntax. Footnotes, math ($…$) and diagrams (Mermaid) are platform extensions this preview does not render: math and Mermaid code appear as plain text, and footnote definitions are hidden.

Everything stays in your browser — nothing you type is uploaded — so it is safe for drafting internal documentation. The text is not saved either: copy your work out before closing the tab.

A README structure that works

Most good README files answer the same questions in the same order. Paste this skeleton into the editor and fill it in:

# Project name

One sentence on what it does and who it is for.

## Installation

```bash
npm install my-package
```

## Usage

The shortest example that works.

## Configuration

| Option | Default | Description |
| --- | --- | --- |
| `debug` | `false` | Log extra detail |

## Contributing / License

Keep the first screen focused on what the project is and how to try it; move long reference material to separate pages and link to them.

These free tools pair well with this page — open them in a new tab to finish your workflow.

常見問題

什麼是Markdown?

Markdown是John Gruber於2004年創建的輕量級標記語言。它使用純文字格式語法——如**粗體**、_斜體_和#標題——可轉換為HTML。廣泛用於README檔案、文件和內容管理系統。

這個編輯器支援哪種Markdown方言?

此編輯器使用GitHub風格Markdown(GFM),這是最常見的標準。它擴展了標準Markdown,增加了表格、刪除線文字(~~文字~~)、任務清單和可標註語言的圍欄代碼區塊等功能(預覽以等寬字型顯示程式碼,不做語法著色)。

如何在Markdown中建立表格?

使用管道符(|)和連字符(-)建立表格: | 標題1 | 標題2 | |-------|-------| | 儲存格1 | 儲存格2 | 每個標題儲存格之間至少需要三個連字符。

我可以在Markdown中使用HTML嗎?

可以,大多數Markdown解析器允許內嵌原始HTML標籤。這在Markdown不支援的元素中很有用,例如<kbd>鍵盤</kbd>標籤、帶<span style>的彩色文字,或通過<sub>/<sup>實現下標/上標。

圍欄代碼區塊和縮排代碼區塊有什麼區別?

縮排代碼區塊在每行前使用4個空格或定位字元。圍欄代碼區塊在代碼前後使用三個反引號(```或~~~),支援選用的語言提示以實現語法高亮,是現代首選的方式。