Giter VIP home page Giter VIP logo

vscode-markdown's Introduction

Markdown Support for Visual Studio Code

version
installs
AppVeyor
GitHub stars

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 -->)
    • To make TOC compatible with GitHub, you might need to set options encodeUri and toLowerCase to false
  • Outline view in explorer panel
  • Automatically show preview when opening a Markdown file (Disabled by default)
  • Print 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 (continue list 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 will be remove on Enter
  • GitHub Flavored Markdown
    • Table formatter (Alt + Shift + F)
    • Task list (use Alt + C to check/uncheck a list item)
  • Math rendering (see screenshot below)
  • Word completion (moved to a standalone extension Dictionary Completion)
  • Others
    • Override "Open Preview" keybinding with "Toggle Preview", which means you can close preview using the same keybinding (Ctrl + Shift + V or Ctrl + K V).

Keyboard Shortcuts

shortcuts2

shortcuts3

Table of Contents

toc

List Editing

list editing

Table Formatter

table formatter

Outline

outline

Task Lists

task lists

Math Rendering

math rendering

Shortcuts

Key Command
Ctrl + B Toggle bold
Ctrl + I Toggle italic
Alt + S Toggle strikethrough
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: 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 true Automatically update the table of contents on save.
markdown.extension.toc.githubCompatibility false GitHub compatibility
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

See CHANGELOG for more information.

Contributing

Bugs, feature requests and more, in GitHub Issues.

Or leave a review on vscode marketplace ๐Ÿ˜‰.

vscode-markdown's People

Contributors

zkirkland avatar vladislav-lyuminarskiy avatar karbassi avatar forloveofcats avatar matsuyanagi avatar magicpro1994 avatar rbolsius avatar

Watchers

James Cloos avatar Jeroen Wiert Pluimers avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.