https://github.com/nstechbytes/markdown-showcase
A Markdown previewer for VS Code with live updates, themes, and image support.
https://github.com/nstechbytes/markdown-showcase
Last synced: 2 months ago
JSON representation
A Markdown previewer for VS Code with live updates, themes, and image support.
- Host: GitHub
- URL: https://github.com/nstechbytes/markdown-showcase
- Owner: NSTechBytes
- License: apache-2.0
- Created: 2025-02-10T10:57:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-10T12:21:56.000Z (over 1 year ago)
- Last Synced: 2025-02-10T12:34:33.944Z (over 1 year ago)
- Language: JavaScript
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📝 Markdown Showcase - A Powerful Markdown Previewer for VS Code
**Markdown Showcase** is a **lightweight yet powerful** extension for **Visual Studio Code** that provides a **live preview** of Markdown files. It supports **images (local & remote), themes, tables, quotes, and more**.
---
## 🚀 Features
✅ **Live Markdown Preview** – Automatically updates as you type.`
`
✅ **Supports Local & Remote Images** – Displays images from your system or the web.`
`
✅ **Light & Dark Themes** – Switch themes easily from the toolbar.`
`
✅ **Enhanced Table & Quote Styling** – Styled to match GitHub’s Markdown.`
`
✅ **Context Menu Integration** – Right-click a Markdown file to open the preview.`
`
---
## 🛠️ Installation
### Install via VS Code:
1. Open **VS Code**
2. Go to **Extensions** (`Ctrl+Shift+X`)
3. Search for **"Markdown Showcase"**
4. Click **Install**
### Install via Command:
Run the following command in **VS Code**:
```sh
ext install NSTechBytes.markdown-showcase
```
---
## 📚 Usage
1. Open a **Markdown (`.md`) file**
2. Open the Command Palette (`Ctrl+Shift+P`)
3. Search for **"Markdown Showcase: Open Markdown Preview"** and select it.
4. **OR** Right-click the file and choose **"Open Markdown Showcase"** from the context menu.
---
## 🎨 Theme Customization
- Click the **theme selector** in the preview.
- Choose between **Light Mode** or **Dark Mode**.
- The setting is **saved automatically** for future sessions.
---
## Showcase
## 🛠️ Development & Contribution
Want to improve **Markdown Showcase**? Feel free to **fork** this repository and submit a **pull request**.
### Clone the Repository:
```sh
git clone https://github.com/NSTechBytes/Markdown-Showcase.git
```
### Install Dependencies:
```sh
npm install
```
### Run the Extension in VS Code:
```sh
npm run test
```
---
## 🐟 License
This project is licensed under the Apache 2.0 **License**.
---
## ⭐ Support
If you like **Markdown Showcase**, please **star ⭐ this repository**! 😊
For issues & feature requests, open an **issue** on [GitHub](https://github.com/NSTechBytes/Markdown-Showcase/issues).