MarkdownEditing

Markdown plugin for Sublime Text

MarkdownEditing

with...

See configuration section to learn how to change the color scheme.

Most features are available through Command Palette.

  1. Open Command Palette ctrl + shift + P (Windows, Linux) or + + P (on Mac)
  2. Type MarkdownEditing: to display a list of available commands.

They are only visible if a markdown file is open and focused.

Features

Folding and Navigation

  • displays headings in Goto Symbol...
  • displays headings in Goto Symbol in Project...
  • fold current section
  • fold by heading levels
  • navigate between adjacent headings with Find Next/Previous Heading command.

Headings

Lists

  • At the end of a list item, pressing Enter will automatically insert the new list item bullet.
  • Pressing Tab on the blank list item will indent it and switch the list bullet to another one (Order is *, -, + in a cycle).
  • Pressing Shift + Tab on the blank list item will unindent it in the same way as above.
  • Sequential Tab s or Shift Tab s are supported.
  • You can disable automatic bullet switching or choose which bullets to be used, in your settings file (mde.list_indent_bullets).
  • If a list item contains a GFM Task, pressing
    • Enter at the end of the line continues with a new blank task.
    • Alt+X in the line toggles the check mark.

Blockquotes

  • At the end of a blockquote line, pressing Enter will automatically extend blockquote.
  • Selecting some text and pressing > will convert it to blockquote. The first and the last line don't have to be fully selected; partial select works, too.

Critic Markup

  • Syntax highlighting for inline critic markup
    • {++ addition ++}
    • {>> comment <<}
    • {-- deletion --}
    • {== highlight==}{>> comment <<}
    • {~~ substitution ~> by ~~}
  • Reviewers can add critic via key bindings
  • Authors can accept or reject critic via key bindings
  • Left bracket pairing is modified to eliminate the selection and leave the cursor at a point where you can insert a [] or () pair for a link.
  • URL part of images, links and references is automatically folded if caret is not within brackets
  • Convert inline links to references
  • Jump between definitions and references
  • Organize references
  • Add or remove footnotes

Text Formatting

  • Asterisks (*), backticks (`) and underscores (_) are auto-paired and wrap selected text
  • ~ wraps selected text with ~~ (strike-through)
  • Backspace deletes an empty pair
  • Space or Tab deletes right element of empty pair of asterisks or underscores