Markdown Editing Docs

Markdown plugin for Sublime Text. Provides a decent Markdown color scheme (light and dark) with more robust syntax highlighting and useful Markdown editing features for Sublime Text. 3 flavors are supported: Standard Markdown, GitHub flavored Markdown, MultiMarkdown.

Dark and yellow theme available, plus thirdparty themes. See configuration section to learn how to change the theme.

Overview

• Installation
• Features
• Key Bindings
• GFM Specific Features
• Commands for Command Palette
• Configuration
• Tips
• Similar Plugins
• Known Bugs
• Contributing
• Credits
• Donation
• License

Installation

Important Note About Installation

Are you getting this error after installation: Error loading syntax file “Packages/Markdown/Markdown.tmLanguage”: Unable to open Packages/Markdown/Markdown.tmLanguage? This is caused by open markdown files at the install time. You have to manually change their syntax to your newly installed Markdown syntax. Read the below paragraph for more details on this.

Note: Sublime text has a native tiny package for Markdown. However, when MarkdownEditing is enabled, native package causes some conflicts. For this reason, MarkdownEditing will automatically disable it. Since it doesn’t bring anything new over MarkdownEditing, this is not a loss. But remember, when you disable MarkdownEditing, you have to reenable the native one manually (if you want).

If you are using Sublime Text 2, you have to disable the native package manually. To do that, add Markdown to your ignored_packages list in ST user settings:

"ignored_packages": [..., "Markdown"],

Package Control

The preferred method of installation is via Sublime Package Control.

1. Install Sublime Package Control
2. From inside Sublime Text, open Package Control’s Command Pallet: CTRL SHIFT P (Windows, Linux) or CMD SHIFT P on Mac.
3. Type install package and hit Return. A list of available packages will be displayed.
4. Type MarkdownEditing and hit Return. The package will be downloaded to the appropriate directory.
5. Restart Sublime Text to complete installation. Open a Markdown file and this custom theme. The features listed below should now be available.

Manual Installation

1. Download or clone this repository to a directory MarkdownEditing in the Sublime Text Packages directory for your platform:
   • Mac: git clone https://github.com/SublimeText-Markdown/MarkdownEditing.git ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/MarkdownEditing
   • Windows: git clone https://github.com/SublimeText-Markdown/MarkdownEditing.git %APPDATA%\Sublime/ Text/ 2/\MarkdownEditing
   • Linux: git clone https://github.com/SublimeText-Markdown/MarkdownEditing.git ~/.Sublime\ Text\ 2/Packages/MarkdownEditing
2. Restart Sublime Text to complete installation. Open a Markdown file and this custom theme. The features listed above should now be available.

Features

• Asterisks and underscores are autopaired and will wrap selected text
  • If you start an empty pair and hit backspace, both elements are deleted
  • If you start an empty pair and hit space, the right element is deleted
• Backticks are paired
• 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.
  • If a list item contains a GFM task, pressing Enter at the end of the line will continue with a new blank task.
• 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.
• 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
• Displays Markdown headers in the Project Symbol List (Ctrl Shift R). They will start with #, so you will know they belong to markdown files at a glance. Also they will be on top of the list because of the precedence of #.
• ~ wraps selected text with ~~ (strikethrough).
• Typing # when there’s a selection will surround it with # to make it a headline. Multiple presses add additional hashes, increasing the level of the header. Once you hit 6 hashes, it will reset to 0 on the next press. The mde.match_header_hashes will determine if the # are mirrored on both sides or just at the beginning of the line.
• Typing return at the end of a line that begins with hashmarks will insert closing hashmarks on the headline. They’re not required for Markdown, it’s just aesthetics, and you can change the mde.match_header_hashes option in your settings to enable (disabled by default).
• Setext-style headers can be completed with Tab. That is, typing Tab on a line containing only = or - characters will add or remove enough characters to it to match the length of the line above.
• New documents will be named automatically based on the first header.

Key Bindings

GFM Specific Features

Underscores in words doesn’t mess with bold or italic style:

Fenced code blocks gets syntax highlighting inside:

Keyboard shortcuts gets highlighted like in GitHub:

Strikethrough is supported:

Commands for Command Palette

Fix Underlined Headers

Adjusts every setext-style header to add or remove = or - characters as needed to match the lengths of their header text.

Convert Underlined Headers to ATX

Converts every setext-style header into an ATX style header. If something is selected only the headers in the selections will be converted, otherwise the conversion will be applied to the whole view.

Add Missing Link Labels

Scans document for referenced link usages ([some link][some_ref] and [some link][]) and checks if they are all defined. If there are undefined link references, command will automatically create their definition snippet at the bottom of the file.

Markdown Lint

Performs lint on current Markdown file. See lint rules. Some of the linting rules are customizable via user settings file.

Switch List Bullet Type

Switches the highlighted list between numbered and bulleted style.

Magic Footnotes Command

Adds a footnote after the word under cursor. If cursor is already on a footnote, jumps to its definition or reference.

Gather Missing Footnotes

Add definition stubs (if there is none) for all footnotes references.

Jump Reference

Jumps cursor between definitions and references.

New Reference

Adds a new link under cursor.

New Inline Link

Adds a new inline link under cursor.

New Inline Image

Adds a new inline image under cursor.

New Image

Adds a new image under cursor.

New Footnote

Adds a footnote under cursor.

Delete Reference

Deletes the definition and references of a link.

Organize References

Sorts and gives a report on current link references usage.

Configuration

The plugin contains 3 different Markdown flavors: Standard Markdown, GitHub flavored Markdown, MultiMarkdown. Default is GitHub flavored Markdown. If you want to set another one as default, open a Markdown file and select your flavor from the menu: View > Syntax > Open all with current extension as. You’re done.

You may want to have a look at the default settings files. They are located at:

Packages/MarkdownEditing/Markdown.sublime-settings         [GitHub flavored Markdown]
Packages/MarkdownEditing/Markdown (Standard).sublime-settings
Packages/MarkdownEditing/MultiMarkdown.sublime-settings

If you want to override any of the default settings, you can open the appropriate user settings file using the Preferences > Package Settings > Markdown Editing menu. Each flavor has a different settings file.

Bold and italic markers are configurable through ST shell variables. You can use Preferences > Package Settings > Markdown Editing menu to see the default settings file. In order to override it, copy & paste its content into the user settings file (Packages/User/Bold and Italic Markers.tmPreferences) from the menu and make your edits. It is pretty straightforward.

In order to activate the dark or the yellow theme, put one of these lines to your user settings file of the flavor (Packages/User/[flavor].sublime-settings):

"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-Dark.tmTheme",
"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-Yellow.tmTheme",
"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-ArcDark.tmTheme",

If you want to go with your already existing theme, you can reenable it with the same method as above. Keep in mind that, that theme may not cover all the parts of the Markdown syntax that this plugin defines.

Additional color themes:

• Blackboard theme by @mdesantis
• monokaiC by @avivace

By default, when you install the plugin, files with these extensions will be assigned to Markdown syntax: “md”, “txt”, “mdown”, “markdown”, “markdn”. If you want to prevent any of these extensions to be opened as Markdown, follow these steps:

1. Click on the language menu at bottom right
2. Select “Open all with current extension as”
3. Choose your preferred syntax for that extension

Tips

We are maintaining a tips section in our Wiki. Jump there to learn from others or share your experiences with others.

Enable WYSIWYG

Sublime can be configured into a WYSIWYG (what you see is what you get) editor with two other plugins:

1. Markdown Preview (https://packagecontrol.io/packages/Markdown%20Preview)
2. Livereload (https://packagecontrol.io/packages/LiveReload)

Install them if you haven’t. Then

1. Open Palette
2. LiveReload: Enable/Disable Plugins
3. Enable Simple Reload.

Now open palette and choose “Preview in Broswer” and you will get a WYSIWYG editor.

Related Plugins

• Knockdown

  Knockdown offers useful Markdown features and a custom Markdown theme. All of its unique features except its theme are ported to MarkdownEditing and some of them are actually improved further in MarkdownEditing.

• Sublime Markdown Extended
• SmartMarkdown
• See https://packagecontrol.io/search/markdown for more.

Known Bugs

• Setext-style headers (=== and ---) do not show up in the symbol list. This is due to a Sublime Text limitation (see #158). However, we are able to put a placeholder to indicate the existence of the header. We encourage you to use Atx-style headers (#).

• Installing for the first time while having markdown files opened may cause MarkdownEditing to behave unexpectedly on those files. Close and reopen those files to fix it.

Contributing

See CONTRIBUTING.md file.

Credits

MarkdownEditing was originally created by Brett Terpstra and has become a community project with the goal of consolidating the best features from the varied collection of Markdown packages for Sublime Text. Current development is headed up by Ali Ayas and Felix Hao.

Related blog posts from Brett:

• http://brettterpstra.com/2012/05/17/markdown-editing-for-sublime-text-2-humble-beginnings/
• http://brettterpstra.com/2013/11/23/markdownediting-for-sublime-text-updates/

This plugin contains portions of code from Knockdown.

Footnote commands were submitted by J. Nicholas Geist and originated at geekabouttown.

Donation

You can support contributors of this project individually. Every contributor is welcomed to add his/her line below with any content. Ordering shall be alphabetically by GitHub username.

• @felixhao28:
• @maliayas:

License

MarkdownEditing is released under the MIT License.