06 / Markdown / markdown-viewer

Markdown Viewer

Preview Markdown side by side with safe rendering.

ReadyLocal processing
06 · Workspace

How to use

  1. 01Paste or type Markdown into the Markdown input on the left. A sample README is loaded so you can see how each element renders.
  2. 02Watch the Preview panel on the right update as you type. There is no render button.
  3. 03Scroll the preview to check headings, lists, tables, code blocks, links and images.
  4. 04Use Copy Markdown to copy the source back to your clipboard once you've fixed it.
  5. 05Press Clear to empty the input and start with a new file.

What is this tool?

The Markdown Viewer is a read-and-check tool. Paste a README, changelog or doc on one side and see the rendered result on the other, with no toolbar or editing aids in the way. It renders GitHub Flavored Markdown, so tables, strikethrough and fenced code blocks look the way they will on most code hosts. The output is sanitized before display, and everything runs locally in your browser.

Previewing a README before you push it

Markdown mistakes are easy to miss in raw text. A table with a missing separator row, a code fence that is never closed, or a list with no blank line before it all look fine in an editor but render wrong once the file is on your code host. Pasting the file into a side-by-side previewer lets you see these problems before you commit.

For example, if you forget the closing triple backticks after an install command, everything below it renders as one long code block. In the preview this shows up right away as a gray monospace wall where your Usage section should be.

Which Markdown features are supported?

The viewer uses the marked parser with GitHub Flavored Markdown turned on. That covers headings, emphasis, links, images, blockquotes, ordered and unordered lists, horizontal rules, fenced code blocks, pipe tables with column alignment, and ~~strikethrough~~.

Each rendered heading also gets an id built from its text. For example, "## Getting Started" becomes id="getting-started", so in-page anchor links like [Setup](#getting-started) point to a real target.

Is it safe to preview untrusted Markdown?

Yes. Markdown can contain raw HTML, so a malicious file could try to slip in a script tag or an onerror handler on an image. Before display, the rendered HTML goes through DOMPurify, which removes scripts, event-handler attributes and javascript: links. This tool also forbids style, iframe and form elements and inline style attributes, so a pasted document can't restyle the page or embed other sites.

Common use cases

  • Checking a README.md before pushing it to a repository
  • Reading Markdown docs or changelogs that only exist as raw text
  • Proofreading a pull request description or release note
  • Reviewing Markdown test reports or bug write-ups from teammates
  • Spotting broken tables or unclosed code fences in documentation

FAQ

How do I preview a Markdown file online?

Open the file in any text editor, copy its contents and paste them into the Markdown input. The rendered preview appears on the right right away.

Does the viewer support GitHub Flavored Markdown?

Yes. GFM is enabled, so pipe tables, strikethrough and fenced code blocks render as they would on most code hosts.

What is the difference between the Markdown Viewer and the Markdown Editor?

The viewer is a plain paste-and-preview pane for checking existing Markdown. The editor adds a formatting toolbar, keyboard shortcuts, view modes, a word count and a .md download for writing new content.

Can a Markdown file run scripts in the preview?

No. The rendered HTML is sanitized with DOMPurify, which strips scripts, event handlers and javascript: links. Iframes, forms and inline styles are also removed.

Is my Markdown uploaded anywhere?

No. Parsing and rendering happen in your browser, and the text never leaves your device.