Giter Club home page Giter Club logo

vscode-markdown's Introduction

Markdown Support for Visual Studio Code

version installs GitHub Workflow Status GitHub stars GitHub Contributors

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)

    toggle bold gif

    check task list

    See full key binding list in the keyboard shortcuts section

  • Table of contents

    toc

    • The indentation rule (tab or spaces) of TOC will be the same of your current file (find it in the right bottom corner)

    • To make TOC compatible with GitHub, set option githubCompatibility to true

    • Use <!-- omit in toc --> to ignore a specific heading in TOC
      (It can also be placed above a heading)

    • You can also use the 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: headings underlined with === or --- can also be omitted, just put their # and ## versions in the setting, respectively.

  • List editing

    on enter key

    on tab/backspace key

    fix ordered list markers

  • Print Markdown to HTML

    • Command Markdown: Print current document to HTML

    • Compatible with Markdown Footnotes

    • It's recommended to print the exported HTML to PDF with browser (e.g. Chrome) if you want to share your documents with others

  • GitHub Flavored Markdown

    • Table formatter

      table formatter

      (Note that the keybinding is Ctrl + Shift + I on Linux)

    • Task list

  • Math

    math

    Please use Markdown+Math for dedicated math support. Be sure to disable math.enabled option of this extension.

  • Auto completions

    Tip: also support the option completion.root

    • Images/Files

      image completions

    • Math functions

      math completions

    • Reference links

      reference links

  • Others

    • Paste link on selected text

      paste link

    • Override "Open Preview" keybinding with "Toggle Preview", which means you can close preview using the same keybinding (Ctrl + Shift + V or Ctrl + K V).

Available Commands

  • Markdown: Create Table of Contents
  • Markdown: Update Table of Contents
  • Markdown: Toggle code span
  • Markdown: Toggle code block
  • Markdown: Print current document to HTML
  • Markdown: Toggle math environment
  • Markdown: Toggle list

Keyboard Shortcuts

Table
Key Command
Ctrl/Cmd + B Toggle bold
Ctrl/Cmd + I Toggle italic
Ctrl/Cmd + Shift + ] Toggle heading (uplevel)
Ctrl/Cmd + Shift + [ Toggle heading (downlevel)
Ctrl/Cmd + M Toggle math environment
Alt + C Check/Uncheck task list item
Ctrl/Cmd + Shift + V Toggle preview
Ctrl/Cmd + K V Toggle preview to side

Supported Settings

Table
Name Default Description
markdown.extension.completion.root Root folder when providing file path completions (It takes effect when the path starts with /)
markdown.extension.italic.indicator * Use * or _ to wrap italic text
markdown.extension.katex.macros {} KaTeX macros e.g. { "\\name": "expansion", ... }
markdown.extension.list.indentationSize adaptive Use different indentation size for ordered and unordered list
markdown.extension.orderedList.autoRenumber true Auto fix list markers as you edits
markdown.extension.orderedList.marker ordered Or one: always use 1. as ordered list marker
markdown.extension.preview.autoShowPreviewToSide false Automatically show preview when opening a Markdown file.
markdown.extension.print.absoluteImgPath true Convert image path to absolute path
markdown.extension.print.imgToBase64 false Convert images to base64 when printing to HTML
markdown.extension.print.onFileSave false Print to HTML on file save
markdown.extension.print.validateUrls true Enable/disable URL validation when printing
markdown.extension.print.theme light Theme of the exported HTML
markdown.extension.syntax.decorations true Add decorations to strikethrough and code spans
markdown.extension.syntax.plainTheme false A distraction-free theme
markdown.extension.tableFormatter.enabled true Enable GFM table formatter
markdown.extension.toc.downcaseLink true Force the TOC links to be lowercase
markdown.extension.toc.githubCompatibility false GitHub compatibility
markdown.extension.toc.omittedFromToc {} Lists of headings to omit by project file (e.g. { "README.md": ["# Introduction"] })
markdown.extension.toc.levels 1..6 Control the heading levels to show in the table of contents.
markdown.extension.toc.orderedList false Use ordered list in the table of contents.
markdown.extension.toc.plaintext false Just plain text.
markdown.extension.toc.unorderedList.marker - Use -, * or + in the table of contents (for unordered list)
markdown.extension.toc.updateOnSave true Automatically update the table of contents on save.

Changelog

See CHANGELOG for more information.

Latest Development Build

Download it here, please click the latest passing event to download artifacts.

To install, execute Extensions: Install from VSIX... in the Command Palette (ctrl + shift + p)

Contributing

Special thanks to all the contributors.


Related

More extensions of mine


Thank VSCode Power User Course for sharing many VSCode tips with me.

VSCode Power User course

vscode-markdown's People

Contributors

alshain avatar axiqia avatar chnicholas avatar dependabot[bot] avatar dorian-marchal avatar ericyd avatar falsecross avatar forloveofcats avatar georchw avatar ibolmo avatar k-sriram avatar leapwill avatar linsui avatar maelvls avatar magicpro1994 avatar matsuyanagi avatar ovsyanka avatar pierremarchand20 avatar rbolsius avatar spmeesseman avatar stefanz8n avatar tianyishi2001 avatar tombresson avatar uasi avatar upupming avatar vladislav-lyuminarskiy avatar wasdee avatar yd278 avatar yzhang-gh avatar zkirkland avatar

Watchers

 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.