Markdown All in One Documentation

Introduction

Welcome!

Markdown All in One is glad to enhance your Markdown editing experience with Visual Studio Codeopen in new window.

Please learn about VS Code's built-in Markdown featuresopen in new window before proceeding.

Features

Basic editing

  • Toggle bold, italic, strikethrough, etc.

  • Auto continuation for block quote.

List editing

  • Auto continuation on Enter.

  • Adaptive indentation size according to the CommonMark Spec.

  • Increase and decrease level by Tab and Backspace.

  • Toggle task list item.

GitHub Flavored Markdown

  • GFM table formatting.
  • Task list.
  • Strikethrough.

Table of contents

  • Implemented as Markdown list without extended syntax.

  • Create by one command, "Create Table of Contents".

  • Automatically update on file saving.

  • Control heading ID style with the slugifyMode setting: VS Code, GitHub, GitLab, and more.

Exporting Markdown to HTML

  • "Print current document to HTML".
  • "Print documents to HTML".
  • Load Markdown extensions in the same way as VS Code.

Math

  • The pandoc-style LaTeX math.

  • Syntax highlighting in editor powered by TextMate grammar.

  • Rendering in preview powered by KaTeX.

  • Code completion for LaTeX commands.

  • Paste URL over selection to create link.

Auto completion for links to:

  • Images and other workspace resources (files).

  • Headings.

  • Reference links.

Others

  • A few "Close preview" key bindings to VS Code's built-in Markdown preview, enabling you to close the preview using the same shortcut as "Open Preview".

Syntax support

See Markdown syntax and flavors for details.

  • CommonMark
  • GitHub Flavored Markdown
  • LaTeX math (powered by KaTeX)
  • YAML front matter

Looking for other syntax? Markdown All in One is known to be compatible with many other extensions. The following have been tested:

Keyboard shortcuts

See Key binding for details.