Mark Sharp

Mark Sharp is a fast, modern Markdown editor for VS Code. Write Markdown documents quickly with familiar, standard syntax while still seeing a visually-appealing rendered Markdown document.

Mark Sharp is based on Github Flavored Markdown and supports extension features such as tables, Mermaid diagrams, checklists, and more.

Quick Start

Installing the Extension

1. Pre-requisite: First install VS Code if you haven't already.
2. Install Mark Sharp from the VS Code Extension Store.

Launching Mark Sharp

There are several ways to launch the Mark Sharp editor:

1. In the Explorer view, right click on a Markdown file > Open With... > Mark Sharp.
2. When a markdown file is open in VS Code's default editor, run the command Mark Sharp: Switch Editor Mode from the command palette or by clicking the M→ icon on the top right in the editor title bar.

When you edit a markdown file with Mark Sharp, your existing document layout may be altered. It is recommended to back up your documents with a version control system like Git or another method of your choice.

Editing Markdown files

• Use familiar markdown syntax to create Markdown elements. For example, typing '#' at the beginning of a line will create an H1 header, or surrounding a word with '*' will bold it.
• Type '/' to bring up a slash command menu to quickly insert markdown elements such as lists, tables, images, and diagrams.
• Use the command Mark Sharp: Switch Editor Mode to switch between Mark Sharp and the built-in VS Code Editor, while maintaining your cursor position so that you can continue working without losing your context.

For a complete guide, see the in depth user guide.

Mark Sharp Premium

Mark Sharp works out of the box as a fully functioning Markdown renderer and supports the basics for editing Markdown files. To unlock rich editing features and to support the continued development of Mark Sharp, please see purchasing a license.

Before using Mark Sharp, please read the End User License Agreement, the Privacy Policy, and the Telemetry Notice.

Acknowledgements

Mark Sharp would not be possible without the contributions of the open source community. For a full list of third-party libraries and their authors, please see Acknowledgements. Thank you for making Mark Sharp possible!

And lastly, thank you to everyone who has supported Mark Sharp, especially those who have helped with testing, filed bugs, and made feature suggestions! This editor is made for you and would not be possible without your help.