eschoool / markdowneditor

A Visual Studio extension

Markdown Editor

Download this extension from the VS Gallery or get the CI build.

---

A full featured Markdown editor with live preview and syntax highligting. Supports GitHub flavored Markdown.

See the changelog for changes and roadmap. http://google.com

Features

• Powered by Markdig - the best markdown parser
• Syntax highlighting supporting GitHub flavor
• Live preview window
• High-DPI support
• Drag 'n drop of images supported
• Paste image from clipboard directly onto document
• Outlining/folding of code blocks
• Keyboard shortcuts
• Brace completion with type-through
• Lightning fast

Syntax highlighting

All fonts can be changed in Tools -> Options -> Environment -> Fonts and Colors dialog.

GitHub and other flavors

Advanced markdown extensions are supported to give more features to the syntax. This includes pipe tables, emoji, mathematics and a lot more.

Live Preview Window

The preview window opens up on the right side of the document when it opens.

Every time the markdown document is saved, the preview window will update and maintain the scroll position.

Any code blocks recieves full syntax highligting in the preview window. Here's an example of JavaScript code rendered.

Live preview can be disabled in the settings.

The syntax highligter is powered by Prism

Drag 'n drop images

Drag an image directly from Solution Explorer onto the document to insert the appropriate markdown that will render the image.

Paste images

This is really helpful for copying images from a browser or for inserting screenshots. Simply copy an image into the clipboard and paste it directly into the document. This will prompt you for a file name relative to the document and then it inserts the appropriate markdown.

It will even parse the file name and make a friendly name to use for the alt text.

Outlining

Any fenced code and HTML blocks can be collapsed, so that tihs:

...can be collapsed into this:

Keyboard shortcuts

Hotkeys are available for making text bold and italic. Select the text and hit Ctrl+B for bold and Ctrl+I for italic.

Bold will surround the selected text with ** and italic surrounds with _.

Comments can be inserted by hitting Ctrl+K,C and you can remove comments by hitting Ctrl+K,U.

Hitting Tab while on a list item will increase its indentation and Ctrl+Tab will decrease it.

This feature overrides build in commands such as Incremental Search so they hotkeys can be disabled in the settings.

Brace completion with type-through

This makes typing faster. Whenever you type opening braces, paranthesis or brackets, a corrosponding closing character is inserted. It is smart about when it adds the closing character so it doesn't become annoying.

It also inserts * and _ characters to make typing bold and italic text as fast as possible.

This feature can be disabled in the settings.

Settings

Control the settings for this extension under Tools -> Options -> Text Editor -> Markdown

Contribute

Check out the contribution guidelines if you want to contribute to this project.

For cloning and building this project yourself, make sure to install the Extensibility Tools 2015 extension for Visual Studio which enables some features used by this project.

License

Apache 2.0