Skip to content

aqz236/vscode-markdown-editor

 
 

Repository files navigation

Markdown Editor — A full-featured WYSIWYG editor for markdown

📝 Fork Changelog

This fork includes several enhancements and new features:

🚀 New Features

  • 🎨 External CSS Support - Load external CSS files from URLs or local paths
    • Support for HTTP/HTTPS URLs and local file paths
    • Configurable CSS loading order
    • Hot reload when configuration changes
    • See EXTERNAL_CSS_README.md for details

alt text

alt text

Here is the effect of the new feature:

alt text

  • ⚙️ Enhanced Editor Options

    • Configurable outline display settings
    • Optional default editor behavior for .md files
    • Menu button to open markdown files in split view

alt text

🛠️ Technical Improvements

  • 🔧 Build System Enhancement - Switched from pnpm to bun for faster builds
  • 🐛 Bug Fixes - Fixed OverlayWebview disposal issues
  • 🎯 UI/UX Improvements - Added distinct icons for menu buttons

🔧 Configuration Options

New configuration options available:

  • markdown-editor.externalCssFiles - Array of external CSS file paths/URLs
  • markdown-editor.cssLoadOrder - Control CSS loading priority
  • markdown-editor.outlineDisplaySetting - Configure outline panel behavior

Demo

demo

Features

  • What You See Is What You Get (WYSIWYG)
  • Auto sync changes between the VSCode editor and webview
  • Copy markdown/html
  • Uploaded/pasted/drag-dropped images will be auto-saved to the assets folder
  • Multi-theme support
  • Shortcut keys
  • Multiple editting modes: instant Rendering mode (Recommand!) / WYSIWYG mode / split screen mode
  • Markdown extensions
  • Multiple graph support including KaTeX / Mermaid / Graphviz / ECharts / abc.js(notation) / ...
  • For more usage please seevditor

Install

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

Supported syntax

demo article

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. Key bindings

  • open a markdown file
  • type ctrl+shift+alt+m for win or cmd+shift+alt+m for mac

3. Explorer Context menu

  • right click on markdown file
  • then click Open with markdown editor

4. Editor title context menu

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

Development

Building and Packaging

This project includes automated build scripts for easy development and packaging:

# Build and create VSIX package
npm run package

# Build and publish (with version bump)
npm run publish

# Build and package only (no publish)
npm run publish:package-only

# Build and publish without version bump
npm run publish:skip-version

For more details, see scripts/README.md.

Custom CSS (custom layout and vditor personalization)

Edit your settings.json and add

"markdown-editor.customCss": "my custom css rules"

// Eg: "markdown-editor.customCss": ".vditor-ir pre.vditor-reset {line-height: 32px;padding-right: calc(100% - 800px) !important; margin-left: 100px;    font-family: system-ui !important;}"

Acknowledgement

Todo

License

MIT

123

Support

If you like this extension make sure to star the repo. I am always looking for new ideas and feedback. In addition, it is possible to donate via paypal.

About

A vscode extension to make your vscode become a full-featured WYSIWYG markdown editor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 89.4%
  • CSS 6.3%
  • Shell 2.7%
  • HTML 1.6%