README Live Preview

Preview your Markdown files in GitHub-style formatting, directly inside VS Code.

Tired of pushing your README to GitHub just to see how it looks? This extension gives you an instant, accurate preview with the exact same styling, syntax highlighting, and layout GitHub uses - without leaving your editor.

Features

Authentic GitHub styling - your README looks exactly as it would on GitHub
Side-by-side preview - edit and preview at the same time
Live updates - preview refreshes automatically every time you save
Syntax highlighting - 200+ languages supported in fenced code blocks
Full Markdown support - tables, images, blockquotes, task lists, inline code, and more
Dark mode - adapts automatically to your VS Code theme

How to Use

Open any .md file, then use one of the following methods:

Right-click in the Explorer Right-click any .md file in the Explorer panel and choose one of the preview commands.

Right-click in the Editor With a .md file open, right-click anywhere in the editor to access the commands.

Command Palette Press Ctrl+Shift+P (or Cmd+Shift+P on Mac), type README Live Preview, and select a command.

Commands

Command	Description
`README Live Preview: Open Preview`	Opens the preview in the current panel
`README Live Preview: Open Preview to Side`	Opens the preview in a split panel beside your editor

Supported Markdown

Headings, bold, italic, strikethrough, ordered and unordered lists, code blocks with syntax highlighting, inline code, tables, images, links, blockquotes, and horizontal rules.

Troubleshooting

The commands do not appear. Commands are only available when a .md file is active or selected. Make sure the file extension is .md.

The preview is not updating. The preview refreshes on save. Press Ctrl+S to save, and the preview will update. If it still does not refresh, close and reopen the preview.

License

MIT License - free to use.

Made by Vidhi Bhutia