📖 Readme Previewer – Markdown Preview for VS Code
Preview your README.md (and other markdown files) inside Visual Studio Code with a clean layout that automatically adapts to your editor theme.
✨ Features
- 🔹 Adapts to VS Code Theme: Light, Dark, and High Contrast are supported automatically.
- 🔹 Syntax Highlighting: Code blocks styled with Highlight.js, matching your active theme.
- 🔹 Auto Refresh: Updates when you save the file.
- 🔹 Works Offline: No external CDN requests; all styles are bundled within the extension.
- 🔹 Secure Rendering: Prevents execution of scripts inside Markdown, fully isolating the preview.
📦 Requirements
- Visual Studio Code: version
1.90.0 or higher.
🚀 Installation & Usage
- Install from the VS Code Marketplace
(Alternatively, search for "Readme Previewer" in your VS Code Extensions view).
- Open any
README.md (or any .md) file in VS Code.
- Click on the Preview option from the footer status bar or Run the command
Preview README from the Command Palette (Ctrl+Shift+P).
- A side-by-side preview opens with full markdown rendering, following the active editor theme.
Note: The preview’s appearance follows your current VS Code color theme automatically and works entirely offline.
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to open an issue or a pull request on our GitHub Repository.
📄 License & Security
This project is licensed under the MIT License. Please refer to SECURITY.md for security guidelines and vulnerability reporting.
| |
