Readme Preview

A VS Code extension that provides a live preview of README.md files as they would appear on GitHub, GitLab, and Bitbucket.

Features

• Real-time Preview: See changes to your README.md file instantly as you type
• Multiple Platform Support: Toggle between GitHub, GitLab, and Bitbucket styles
• Theme Support: Light and dark theme support that matches your VS Code theme
• Custom CSS: Option to apply custom CSS to the preview
• Image Support: View local and remote images in the preview
• Markdown Support: Full support for GitHub Flavored Markdown (GFM)

Installation

1. Open VS Code
2. Go to Extensions view (Ctrl+Shift+X or Cmd+Shift+X)
3. Search for "Readme Preview"
4. Click Install

Usage

1. Open a markdown file (.md, .markdown)
2. Click the Readme Preview icon in the Activity Bar
3. The preview will update automatically as you type

Commands

• Readme Preview: Open Preview - Open the preview in a side panel
• Readme Preview: Refresh Preview - Manually refresh the preview
• Readme Preview: Toggle Theme - Toggle between light and dark theme

Settings

{
  "readmePreview.autoRefresh": true,
  "readmePreview.defaultPlatform": "github",
  "readmePreview.showInSidebar": true,
  "readmePreview.customCSS": ""
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.