# vscode-markdown-editor

**Repository Path**: joliu/vscode-markdown-editor

## Basic Information

- **Project Name**: vscode-markdown-editor
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 8
- **Created**: 2021-04-23
- **Last Updated**: 2021-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Editor — A full-featured WYSIWYG editor for markdown

## Features

* What You See Is What You Get (WYSIWYG)
* Auto sync changes between vsc editor and webview
* Copy markdown/html
* Upload/paste/drag-drop images will auto save to `assets` folder
* Multi-theme support
* Shortcut keys
* Wysiwyg mode & split screen mode
* Markdown extensions
* Multiple graph support including KaTeX / Mermaid / Graphviz / ECharts / abc.js(notation) / ...
* For more usage please see [vditor](https://github.com/Vanessa219/vditor)

## Install

<https://marketplace.visualstudio.com/items?itemName=zaaack.markdown-editor>

## Support syntax

[demo article](https://ld246.com/guide/markdown)

## Usage

### 1. Command mode in markdown file

* open a markdown file
* type `cmd-shift-p` to enter command mode
* type `markdown-editor: Open with markdown editor`

### 2. Explorer Context menu

* right click on markdown file
* then click `Open with markdown editor`

### 3. Editor title context menu

* right click on a opened markdown file's tab title
* then click `Open with markdown editor`

## Demo

![demo](./demo.gif)

## Acknowledgement

* [vscode](https://github.com/microsoft/vscode)
* [vditor](https://github.com/Vanessa219/vditor)

## Todo

* [ ] Using [Custom Text Editor](https://code.visualstudio.com/api/extension-guides/custom-editors#custom-text-editor) ([demo](https://github.com/gera2ld/markmap-vscode))

## License

MIT