1.Markdown

1.1. Introduction

Markdown is a markup language that can be written with a normal text editor. With simple markup syntax, it can make ordinary text content have a certain format. Its purpose is “easy to read and write”, so it is lightweight, simple and versatile.

Markdown is used for a wide range of purposes, such as blogging, documentation, etc. Markdown files are formatted as.md.

1.2. Standard Markdown syntax

2.VS Code supports Markdown by default

VS Code supports Markdown syntax by default and supports preview as follows:



3. Install the Markdown extension — autocomplete and shortcut keys

VS Code’s default Markdown support has the following disadvantages:

  • No shortcut keys are supported.
  • Syntax autoprompt is not supported.
  • Latex mathematical formulas are not supported;
  • Does not support everywhere for HTML/PDF;

All of the drawbacks of default Markdown can be solved by installing the corresponding VS Code extension and searching for Markdown in the extension market:

3.1. Auto-complete function

  • Image:

  • A mathematical formula

3.2. Shortcut key function



That concludes our introduction to Markdown documentation using VS Code, and there are more fun extensions to try out if you’re interested, such as:

  • Markdownlint: Dynamically checks Markdown document syntax;
  • Markdown PDF: Convert Markdown documents to PDF documents;
  • Auto-open Markdown Preview: Automatically Open Markdwon Preview;
  • …