https://github.com/remcohaszing/vscode-markdown-decorations

Provide a WYSIWYG-like experience for markdown and MDX files
https://github.com/remcohaszing/vscode-markdown-decorations

markdown mdx vscode vscode-extension wysiwyg

Last synced: 26 days ago
JSON representation

Provide a WYSIWYG-like experience for markdown and MDX files

• Host: GitHub
• URL: https://github.com/remcohaszing/vscode-markdown-decorations
• Owner: remcohaszing
• License: mit
• Created: 2023-10-24T12:50:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-24T13:04:56.000Z (over 1 year ago)
• Last Synced: 2025-03-29T08:43:31.115Z (about 2 months ago)
• Topics: markdown, mdx, vscode, vscode-extension, wysiwyg
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=remcohaszing.markdown-decorations
• Size: 186 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Markdown WYSIWYG

[![github actions](https://github.com/remcohaszing/vscode-markdown-decorations/actions/workflows/ci.yaml/badge.svg)](https://github.com/remcohaszing/vscode-markdown-decorations/actions/workflows/ci.yaml)

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/remcohaszing.markdown-decorations)](https://marketplace.visualstudio.com/items?itemName=remcohaszing.markdown-decorations)

[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/remcohaszing.markdown-decorations)](https://marketplace.visualstudio.com/items?itemName=remcohaszing.markdown-decorations)

[![Open VSX Version](https://img.shields.io/open-vsx/v/remcohaszing/markdown-decorations)](https://open-vsx.org/extension/remcohaszing/markdown-decorations)

[![Open VSX Downloads](https://img.shields.io/open-vsx/dt/remcohaszing/markdown-decorations)](https://open-vsx.org/extension/remcohaszing/markdown-decorations)

This Visual Studio Code extension provides a WYSIWYG-like experience for markdown and MDX files.

This extension is experimental. Feedback is welcome, and changes are likely to happen.

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Features](#features)

- [License](#license)

## Installation

In Visual Studio Code open the command palette using Ctrl + Shift +

P, paste the following command, and press Enter.

```

ext install remcohaszing.markdown-decorations

```

## Usage

This extension is activated automatically when you open a markdown or MDX file.

## Features

This extension provides some text decorations that make the markdown and MDX editing experience feel

close to a WYSIWYG experience.

![Screenshot showing the extension in action](screenshot.png)

The following decorations are supported:

- Emphasis text is italic.

- Strong text is bold.

- Headers are bold.

- Deleted text is strike-through.

- Thematic breaks have an extended strike-through effect.

- Inline code has a darker background in light mode, and a lighter background in dark mode.

- HTML tags have a darker background in light mode, and a lighter background in dark mode.

- Code blocks have a darker background in light mode, and a lighter background in dark mode.

- Frontmatter has a darker background in light mode, and a lighter background in dark mode.

- Block quotes have a darker background in light mode, and a lighter background in dark mode. This

  effect increases as more block quotes are nested.

- MDX expressions have a darker background in light mode, and a lighter background in dark mode.

## License

[MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)