Skip to content

preview, edit and make you readmes with this simple yet powerful tool.

Notifications You must be signed in to change notification settings

SarvT/md-viewer

Repository files navigation

MD Viewer

Real-time Markdown preview extension for Visual Studio Code with multiple viewing options.

Features

  • Preview markdown files in real-time
  • Multiple viewing options:
    • In the current window
    • Side-by-side split view
    • Floating window
    • New tab
  • Syntax highlighting for code blocks
  • Styled for readability

Usage

When editing a Markdown file (.md), you can preview it in several ways:

  • Right-click in the editor and select one of the MD Viewer options
  • Use keyboard shortcuts:
    • Ctrl+Shift+V (Cmd+Shift+V on Mac): Open preview in current window
    • Ctrl+K V (Cmd+K V on Mac): Open preview to side

Extension Settings

This extension contributes the following commands:

  • md-viewer.openPreview: Open preview in current window
  • md-viewer.openPreviewToSide: Open preview in split view
  • md-viewer.openFloatingPreview: Open preview in floating window
  • md-viewer.openPreviewInNewTab: Open preview in new tab

Requirements

  • Visual Studio Code v1.60.0 or higher

Installation

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "MD Viewer"
  4. Click Install

Known Issues

  • Images with relative paths may not display correctly in all preview modes

Release Notes

0.1.0

Initial release:

  • Basic markdown preview functionality
  • Multiple viewing options
  • Syntax highlighting

About

preview, edit and make you readmes with this simple yet powerful tool.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published