Markdown Preview

Preview Markdown documents

Preview Markdown documents0 chars / 0 lines
Markdown Source
Preview
Preview appears here

Tool guide

About Markdown Preview

Markdown Preview renders Markdown source into a readable preview so you can check headings, lists, links, blockquotes, tables, and code blocks.

Use it before submitting a README, documentation snippet, issue, or blog draft.

How to use Markdown Preview

  1. Paste your Markdown source.
  2. Use the sample to check GFM tables, fenced code blocks, and links.
  3. Review heading hierarchy, list indentation, and link rendering.

When you would use it

  • Check README code block languages and table alignment before committing.
  • Preview a GitHub issue or release note before posting.
  • Inspect API documentation snippets for heading and list nesting.

Markdown syntax and formatting traps

Markdown is lightweight, but blank lines, indentation, and backtick counts affect rendering. GitHub Flavored Markdown adds tables, task lists, and fenced code blocks.

  • Headings use # and should follow a logical hierarchy.
  • Nested lists depend on indentation; mixing tabs and spaces often breaks layout.
  • Fenced code blocks use triple backticks and can include a language name.
  • Link text should be descriptive instead of “click here”.

Markdown Preview FAQ

Does it support GitHub Flavored Markdown?
Common GFM features such as tables, fenced code blocks, and task lists can be previewed, but final rendering depends on the target platform.
Why did my nested list fail?
Usually indentation or missing blank lines. Indent child list items more than the parent and keep marker style consistent.
Is my content uploaded?
No. Markdown rendering runs locally in the browser and is not uploaded to wetool.site.

Markdown Preview vs publishing

Preview catches most formatting issues, but GitHub, npm, forums, and CMS platforms may use different Markdown extensions and sanitizers. Recheck on the target platform before publishing.

Markdown dialect comparison

A preview tool helps catch structure issues, but Markdown dialects differ across platforms.

  • CommonMark covers baseline syntax such as headings, paragraphs, lists, blockquotes, and code blocks.
  • GitHub Flavored Markdown adds common extensions such as tables, task lists, strikethrough, and autolinks.
  • Blogs, CMSs, and documentation sites may add front matter, heading anchors, footnotes, or math formulas.

Safe rendering and publishing boundaries

Markdown preview is not the final publishing environment, especially for HTML, images, external links, and platform filters.

  • Do not treat untrusted Markdown as safe HTML; target platforms usually sanitize raw HTML.
  • External images and links can expose request sources, token parameters, or internal addresses after publishing.
  • Before publishing README, npm docs, or CMS pages, recheck the final rendering on the target platform.