MD Viewer
View Markdown files in VS Code with a live custom preview.
Features
- Rendered preview for
.md and .markdown files.
- Source, preview, and split modes from the editor title bar and command palette.
- Live updates as Markdown source changes.
- Scroll synchronization between source and preview.
- Table of contents for documents with multiple
h2/h3 headings.
- Theme-aware styling using VS Code colors.
Usage
- Open a Markdown file.
- Run
MD Viewer: Toggle Code View, or use Cmd+K / Ctrl+K, to switch between preview and source.
- Run
MD Viewer: Split Source / Preview, or use Cmd+L / Ctrl+L, to edit source beside the preview.
- Use
MD Viewer: Source Mode to return to the text editor.
The extension registers its preview as an optional custom editor so normal Markdown files still open as source by default.
Settings
| Setting |
Default |
Description |
mdViewer.openLinksInEditor |
true |
Open local Markdown links inside VS Code instead of the webview. |
Development
No build step is required; the extension is plain JavaScript.
- Open this folder in VS Code.
- Press
F5 to launch the Extension Development Host.
- Open any
.md file and run MD Viewer: Preview Mode.
Package locally:
npm install
npm run build:local
npm run install:local
License
MIT
| |
