ebeeson / 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)
  • Tip: in normal mode, **word|** -> **word**| (ctrl + b)
  • Quick styling mode: toggle bold/italic without selecting words
• Table of contents (No additional annoying tags like <!-- TOC -->)
• Outline view in explorer panel
• Automatically show preview when opening a Markdown file (Disabled by default)
  • Automatically close preview when changing editor
• Print your Markdown 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
• List editing (when pressing Enter at the end of a list item) (also work for quote block)
  • Pressing Tab at the beginning of a list item will indent it
  • Pressing Backspace at the beginning of a list item will unindent it (or delete the list marker)
  • Blank list item won't be continued
• GitHub Flavored Markdown
  • Table formatter
  • Task lists
• Word completion (moved to a standalone extension Dictionary Completion)

Keyboard Shortcuts

Table of Contents

List Editing

Table Formatter

Outline

Task Lists

Shortcuts

Key	Command
ctrl + b	Toggle bold
ctrl + i	Toggle italic
ctrl + shift + ]	Toggle heading (uplevel)
ctrl + shift + [	Toggle heading (downlevel)
alt + c	Check/Uncheck task list item

Available Commands

• Markdown: Create Table of Contents
• Markdown: Update Table of Contents
• Markdown: Toggle code span
• Markdown: Toggle strikethrough
• Markdown: Print current document to HTML

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	false	Automatically update the table of contents on save.
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.italic.indicator	*	Use * or _ to wrap italic text
markdown.extension.quickStyling	false	Toggle bold/italic without selecting words
markdown.extension.showExplorer	true	Show outline view in explorer panel
markdown.extension.print.absoluteImgPath	true	Convert image path to absolute path

Changelog

1.0.5 (2018.02.01)

• Fix: Option markdown.extension.print.absoluteImgPath doesn't work (#84)

1.0.4 (2018.01.29)

• Fix: TOC entries that contain links do not generate correctly (#83)

1.0.3 (2018.01.23)

• New: Option markdown.extension.print.absoluteImgPath (#81)

See CHANGELOG for more information.

Contributing

Bugs, feature requests and more, in GitHub Issues.

Or leave a review on vscode marketplace 😉.