maelvls/vscode-markdown

Markdown All in One

Markdown Support for Visual Studio Code

All you need for Markdown (keyboard shortcuts, table of contents, auto preview and more).

Features

• Keyboard shortcuts (toggle bold, italic, code span, strikethrough and heading)

  (toggle bold)

  (even when there is no word selected)

  (check/uncheck task list)

  See full key binding list in keyboard shortcuts section

• Table of contents

  

  • The indentation rules (tab or spaces) of TOC will be the same of your current file (find it in the right bottom corner)

  • To make TOC compatible with GitHub, you need to set option githubCompatibility to true

  • Use <!-- omit in toc --> to ignore specific heading in TOC

• List editing

  (Enter)

  (Enter)

  (Tab)

  (Backspace)

  (auto fix ordered list markers)

• Print Markdown to HTML

  • Command Markdown: Print current document to HTML

  • It's recommended to print the exported HTML to PDF with browser (e.g. Chrome) if you want to share your documents with others

• GitHub Flavored Markdown

  • Table formatter

    

  • Task list

• Math

  

• Auto completions

  (images paths)

  (math commands)

• Others

  • Override "Open Preview" keybinding with "Toggle Preview", which means you can close preview using the same keybinding (Ctrl + Shift + V or Ctrl + K V).

Available Commands

• Markdown: Create Table of Contents
• Markdown: Update Table of Contents
• Markdown: Toggle code span
• Markdown: Print current document to HTML
• Markdown: Toggle math environment
• Markdown: Toggle unordered list

Keyboard Shortcuts

Key	Command
Ctrl + B	Toggle bold
Ctrl + I	Toggle italic
Alt + S	Toggle strikethrough
Ctrl + Shift + ]	Toggle heading (uplevel)
Ctrl + Shift + [	Toggle heading (downlevel)
Ctrl + M	Toggle math environment
Alt + C	Check/Uncheck task list item

Tip: **word|** -> **word**| (Ctrl + B)

Supported Settings

Name	Default	Description
markdown.extension.toc.levels	1..6	Control the heading levels to show in the table of contents.
markdown.extension.toc.unorderedList.marker	-	Use -, * or + in the table of contents (for unordered list)
markdown.extension.toc.orderedList	false	Use ordered list in the table of contents.
markdown.extension.toc.plaintext	false	Just plain text.
markdown.extension.toc.updateOnSave	true	Automatically update the table of contents on save.
markdown.extension.toc.githubCompatibility	false	GitHub compatibility
markdown.extension.preview.autoShowPreviewToSide	false	Automatically show preview when opening a Markdown file.
markdown.extension.orderedList.marker	ordered	Or one: always use 1. as ordered list marker
markdown.extension.orderedList.autoRenumber	true	Auto fix list markers as you edits
markdown.extension.italic.indicator	*	Use * or _ to wrap italic text
markdown.extension.showExplorer	true	Show outline view in explorer panel
markdown.extension.print.absoluteImgPath	true	Convert image path to absolute path
markdown.extension.print.imgToBase64	false	Convert images to base64 when printing to HTML
markdown.extension.syntax.decorations	true	Add decorations to strikethrough and code spans
markdown.extension.syntax.plainTheme	false	A distraction-free theme

Changelog

See CHANGELOG for more information.

Latest CI Build

Download it here.

Contributing

Bugs, feature requests and more, in GitHub Issues.

Or leave a review on vscode marketplace 😉.