robole/vscode-marky-markdown

Markdown editing. Redefined.

Marky Markdown

Markdown editing. Redefined.

This is an extension pack of related markdown extensions that I wrote, which add rich editing powers to markdown documents.

The advantage that this extension pack has over an extension such as Markdown All in One is that it is much smaller and is modular. You can disable features by disabling a particular extension. You can go a step further and only install the extensions you want. This gives you a similar feature set, but with a lot more control.

Extensions

1. Marky Edit: Toggle-style editing.
2. Marky Dynamic: Automate updating dynamic content such as Table of Contents.
3. Markdown Snippets: Snippets for extended markdown syntax.
4. Marky Stats: Add stats to the status bar.

Activation

These extensions are only loaded when a markdown file is open. To be more specific, the activation event is onLanguage: markdown.

Commands

The following commands can be run from the Command Palette (Ctrl+Shift+P):

1. Marky Edit: Toggle Delete (Strikethrough)
2. Marky Edit: Toggle Emphasis (Italic)
3. Marky Edit: Toggle Fenced Code Block
4. Marky Edit: Toggle Heading 1
5. Marky Edit: Toggle Heading 2
6. Marky Edit: Toggle Heading 3
7. Marky Edit: Toggle Heading 4
8. Marky Edit: Toggle Heading 5
9. Marky Edit: Toggle Heading 6
10. Marky Edit: Toggle Horizontal Rule
11. Marky Edit: Toggle Image
12. Marky Edit: Toggle Inline Code
13. Marky Edit: Toggle Link
14. Marky Edit: Toggle Ordered List (Bulleted List)
15. Marky Edit: Toggle Quote
16. Marky Edit: Toggle Strong Emphasis (Bold)
17. Marky Edit: Toggle Unordered List (Numbered List)
18. Marky Dynamic: Add/Update the Table of Contents (TOC)
19. Marky Dynamic: Remove the Table of Contents (TOC)
20. Marky Dynamic: Add/Update Heading Bookmarks
21. Marky Dynamic: Remove Heading Bookmarks
22. Marky Dynamic: Add/Update Section Numbering
23. Marky Dynamic: Remove Section Numbering
24. Marky Stats: Select Stat

See individual extensions for up-to-date list.

Major Features Overview

1) Toggle-style editing

Toggle-style editing offers a more natural editing experience. It enables you to mark or unmark text as you type, and insert markdown fragments as snippets for simple completion.

For more information, see Marky Edit.

2) Dynamic content

Editing and reformating documents can leave content such as table of contents out of sync with the rest of the document. This extension enables you to update the table of contents when you save the document.

For more information, see Marky Dynamic.

3) Markdown Snippets

Provides snippets for extended markdown syntax.

For more information, see Markdown Snippets.

4) Document Stats

Stats are displayed on the status bar. By default, it is the Reading Time.

You can choose which stats to show by clicking the status bar item, and selecting from the quickpick menu.

For more information, see Marky Stats.

Extension Settings

You will find options for these extensions by searching for "marky".

Installation

1. The extension is listed in the VS Code Marketplace and Open VSX Marketplace where you can download or install it directly.
2. Inside VS Code: Type Ctrl+P, write ext install robole.marky-markdown in the text field, and hit Enter.
3. From the Command-line: Run the command code --install-extension robole.marky-markdown.

Show appreciation

If you are happy with the extension: please star the repo 🌟, and leave a review in the visual studio marketplace to help others find it. 🌟🌟🌟🌟🌟

You can show your appreciation by buying me a coffee or sponsoring me. This will offer me encouragement to continue, and will provide a path to dedicating more time to open-source in the future.