Markdown Preview in VS Code and Other IDEs
Writing Markdown is only half the workflow. You also need to see how it renders — headings, lists, code blocks, tables, and embedded images. Most modern editors include a built-in Markdown preview, and third-party extensions add features like live reload, custom styling, and GFM support.
VS Code Built-In Preview
VS Code ships with a Markdown preview out of the box. Open a .md file and press Ctrl+Shift+V (Windows/Linux) or Cmd+Shift+V (macOS) to open a preview tab. For a side-by-side view, use Ctrl+K V — the editor sits on the left, and the preview updates on the right as you type.
The built-in preview supports CommonMark by default. You can enable GitHub Flavored Markdown (GFM) — tables, task lists, strikethrough — through workspace settings:
{
"markdown.preview.breaks": "on",
"markdown.preview.typographer": true
}
Custom CSS lets you match the preview to your documentation site's actual styling. Create a .vscode/markdown.css file and reference it in settings:
{
"markdown.styles": [".vscode/markdown.css"]
}
Popular VS Code Markdown extensions:
- Markdown All in One — keyboard shortcuts, table of contents, auto-preview
- Markdown Preview Enhanced — Mermaid diagrams, MathJax, presentation mode
- markdownlint — linting and style enforcement as you write
JetBrains IDEs (IntelliJ, WebStorm, PyCharm)
JetBrains IDEs include a Markdown preview panel that opens automatically when you edit .md files. Click the Preview tab in the editor's bottom-right corner.
Key features:
- Split editor/preview — drag the divider to adjust the layout
- Multiple preview providers — switch between JavaFX, JCEF, and Jupyter renderers in Settings → Languages & Frameworks → Markdown
- Custom CSS — add your own stylesheet under the preview provider settings
- GFM support — tables, task lists, and syntax highlighting in fenced code blocks work by default
The IntelliJ Markdown plugin also supports navigation — Ctrl+Click a relative link to jump to the target file, and auto-complete for link paths.
Vim and Neovim
Vim has no built-in preview, but several plugins fill the gap:
| Plugin | Preview Method | Features |
|---|---|---|
| markdown-preview.nvim | Browser (live) | Live reload, Mermaid, MathJax |
| vim-markdown | Inline rendering | Folding, conceal, syntax |
| glow.nvim | Terminal (glow) | Renders in floating window |
markdown-preview.nvim is the most popular choice. It starts a local server and opens your default browser. Every save triggers a live reload — the browser tab updates instantly.
" Install with vim-plug
Plug 'iamcco/markdown-preview.nvim', { 'do': 'cd app && npm install' }
" Keybindings
nmap <C-p> <Plug>MarkdownPreviewToggle
Browser-Based Preview Tools
Sometimes you need to preview Markdown outside your editor — when reviewing a file on a shared drive, checking a README before committing, or collaborating with non-technical teammates.
Online Markdown preview tools offer:
- Instant rendering — paste or drag a
.mdfile and see the result - GFM compatibility — tables, task lists, autolinks, and footnotes
- Export options — copy rendered HTML, download as PDF
- No installation — works on any device with a browser
This is where a dedicated preview tool adds value beyond what editors provide. You get a consistent, portable preview without installing plugins or configuring CSS.
Preview Consistency Tips
Your editor's preview may not match your production site. These discrepancies cause formatting surprises after publishing:
- CSS differences — editor previews use generic styles; your site uses custom fonts, spacing, and colors
- Markdown dialect — GFM adds tables and task lists that CommonMark lacks
- Plugin rendering — Mermaid diagrams, math blocks, and custom shortcodes may render differently
- Image paths — relative image URLs that work locally may break in production
To minimize surprises:
- Configure your editor preview CSS to match your production stylesheet
- Use the same Markdown parser in preview and production (e.g.,
remarkwith matching plugins) - Test with the same GFM dialect your hosting platform uses
- Validate image paths against your deployment directory structure
Key Takeaways
- VS Code includes a built-in Markdown preview with split-view and custom CSS support
- JetBrains IDEs offer multiple preview renderers and inline link navigation
- Vim users rely on plugins like
markdown-preview.nvimfor browser-based live preview - Browser-based tools provide a portable preview option without editor configuration
- Match your preview CSS and Markdown dialect to your production site to avoid formatting surprises
Related Guides
- Markdown Preview: Real-Time Rendering for Your Documents
- GitHub Flavored Markdown: Extensions and Syntax Guide
- Markdown Writing Workflow: From Draft to Published
Try It Yourself
Preview your Markdown files instantly with our free Markdown Preview tool. Paste your content or upload a .md file — see GFM-rendered output with tables, code blocks, and links in seconds.