Markdown preview for docs, READMEs, and changelogs
왼쪽에서 Markdown 작성, 오른쪽에서 실시간 HTML 미리보기. CommonMark 완전 지원. 브라우저에서 실행.
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)  > 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.
Related tools
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 파일, 문서, CMS 등에서 널리 사용됩니다.
이 편집기는 어떤 Markdown 방언을 지원하나요?
이 편집기는 가장 일반적인 표준인 GitHub Flavored Markdown(GFM)을 사용합니다. 표준 Markdown에 표, 취소선(~~텍스트~~), 작업 목록, 언어를 지정할 수 있는 펜스 코드 블록 등이 추가됩니다(미리보기는 코드를 고정폭 글꼴로 표시하며 색상 강조는 하지 않습니다).
Markdown에서 표를 만드는 방법은?
파이프(|)와 하이픈(-)으로 표를 만듭니다: | 제목1 | 제목2 | |-------|-------| | 셀1 | 셀2 | 각 헤더 셀은 최소 3개의 하이픈으로 구분합니다.
Markdown 안에서 HTML을 사용할 수 있나요?
네, 대부분의 Markdown 파서는 인라인 원시 HTML 태그를 허용합니다. <kbd>키보드</kbd> 레이블, <span style>을 이용한 색상 텍스트, <sub>/<sup>를 통한 아래/위 첨자 등 Markdown이 지원하지 않는 요소에 유용합니다.
펜스 코드 블록과 들여쓰기 코드 블록의 차이는 무엇인가요?
들여쓰기 코드 블록은 각 행 앞에 4칸 공백이나 탭을 사용합니다. 펜스 코드 블록은 코드 앞뒤에 트리플 백틱(``` 또는 ~~~)을 사용하며 구문 강조를 위한 언어 지정이 가능해 현대적으로 선호되는 방식입니다.