https://github.com/brendanddev/vscode-readme-previewer

https://github.com/brendanddev/vscode-readme-previewer

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/brendanddev/vscode-readme-previewer
• Owner: brendanddev
• License: mit
• Created: 2025-08-12T23:52:13.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-08-13T00:08:29.000Z (10 months ago)
• Last Synced: 2025-08-13T02:28:49.980Z (10 months ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VSCode README Previewer

A Visual Studio Code extension that allows you to **preview README.md files inline** directly within VS Code - no switching to a browser required.

---

## Features

- **Inline Preview**: View your README.md files in a side panel without leaving the editor.

- **Markdown Rendering**: Utilizes Markdown-It for accurate rendering of Markdown syntax.

- **Command Palette & Editor Title Integration**: Access preview via the command palette or a button in the editor title bar for quick access.

- **Live Preview**: Automatically updates the preview as you save changes to the README.md file.

- **Live Theme Update**: Automatically updates the preview when the VS Code theme changes between dark and light modes.

- **Code & Tables Styling**: Proper rendering and styling for code blocks, tables, blockquotes, and other Markdown elements.

- **Customizable Settings**: Adjust settings for the previewer via VS Code's settings UI.

- **Keybinding Support**: Easily trigger the preview with a customizable keybinding.

- **Security**: Ensures safe rendering of content with appropriate Content Security Policies.

- **Modern or Classic UI**: Choose between a modern or classic user interface for the preview panel.

---

## Usage