markdocs

[Deprecated]: this repo has been moved to https://github.com/Microsoft/vscode-docs-authoring/tree/master/docs-preview, and please install it from: https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-preview

Markdown preview tool that supports docfx flavored markdown and CommonMark syntax.

Install

Press F1, type ext install markdocs

Usage

Supported markdown snippets

Note You need enable quickSuggestions for markdown as shown below in user perference, because markdown snippets are not shown up automatically in vscode by default:

  "[markdown]":  {
    "editor.quickSuggestions": true
  },

1. File inclusion

   [!include [title](path)]
   

2. Code snippet

   [!code-language[name](path)]
   

3. Note/Warning/Tip/Important/Caution block

   > [!NOTE]
   > content
   > 
   

4. Tabbed content

   # [tab title](#tab/tab-id-1)
   tab content
   # [tab title](#tab/tab-id-2)
   tab content
   ***
   

5. Row extension

   :::row:::
       :::column:::
           content
       :::column-end:::
       :::column:::
           content
       :::column-end:::
    :::row-end:::
   

To Do List

• Enable TypeScript linter
• Supports bidirectional scrolling
• Guideline to customize CSS
• Reduce the size of runtime dependency if dotnet core has already been installed