Markdown All in One installs statistics

Markdown Support for Visual Studio Code <!-- omit in toc -->

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

Note: VS Code has basic Markdown support out-of-the-box (e.g, Markdown preview), please see the official documentation for more information.

Table of Contents

• Features
  • Keyboard shortcuts
  • Table of contents
  • List editing
  • Print Markdown to HTML
  • GitHub Flavored Markdown
  • Math
  • Auto completions
  • Others
• Available Commands
• Keyboard Shortcuts
• Supported Settings
• FAQ
  • Q: Error "command 'markdown.extension.onXXXKey' not found"
  • Q: Which Markdown syntax is supported?
  • Q: This extension has overridden some of my key bindings (e.g. <kbd>Ctrl</kbd> + <kbd>B</kbd>, <kbd>Alt</kbd> + <kbd>C</kbd>)
  • Q: The extension is unresponsive, causing lag etc. (performance issues)
• Changelog
• Latest Development Build
• Contributing
• Related

Features

Keyboard shortcuts

<p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/toggle-bold.gif" alt="toggle bold gif" width="282px"> <br>(Typo: multiple words)</p> <p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/check-task-list.gif" alt="check task list" width="240px"></p>

See full key binding list in the keyboard shortcuts section

Table of contents

<p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/toc.png" alt="toc" width="305px"></p>

• Run command "Create Table of Contents" (in the VS Code Command Palette) to insert a new table of contents.

• The TOC is automatically updated on file save by default. To disable, please change the toc.updateOnSave option.

• The indentation type (tab or spaces) of TOC can be configured per file. Find the setting in the right bottom corner of VS Code's status bar.

  Note: Be sure to also check the list.indentationSize option.

• To make TOC compatible with GitHub or GitLab, set option slugifyMode accordingly

• Three ways to control which headings are present in the TOC:

  <details> <summary>Click to expand</summary>

  1. Add <!-- omit from toc --> at the end of a heading to ignore it in TOC
     (It can also be placed above a heading)

  2. Use toc.levels setting.

  3. You can also use the toc.omittedFromToc setting to omit some headings (and their subheadings) from TOC:

     // In your settings.json
     "markdown.extension.toc.omittedFromToc": {
       // Use a path relative to your workspace.
       "README.md": [
           "# Introduction",
           "## Also omitted",
       ],
       // Or an absolute path for standalone files.
       "/home/foo/Documents/todo-list.md": [
         "## Shame list (I'll never do these)",
       ]
     }
     

     Note:

     • Setext headings (underlined with === or ---) can also be omitted, just put their # and ## versions in the setting, respectively.
     • When omitting heading, make sure headings within a document are unique. Duplicate headings may lead to unpredictable behavior.
  </details>

• Easily add/update/remove section numbering

  <img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/section-numbers.gif" alt="section numbers" width="768px">

• In case you are seeing unexpected TOC recognition, you can add a <!-- no toc --> comment above the list.

List editing

<p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/on-enter-key.gif" alt="on enter key" width="214px"></p> <p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/tab-backspace.gif" alt="on tab/backspace key" width="214px"></p> <p><img src="https://github.com/yzhang-gh/vscode-markdown/raw/master/images/gifs/fix-marker.gif" alt="fix ordered list markers" width="214px"></p>

Note: By default, this extension tries to determine indentation size for different lists according to CommonMark Spec. If you prefer to use a fixed tab size, please change the list.indentationSize setting.

Print Markdown to HTML

• Commands Markdown: Print current document to HTML and Markdown: Print documents to HTML (batch mode)…