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.
- 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
- 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 - ⌘ ⌥ V will paste the contents of the clipboard as an inline link on selected text
- ⌘ ⌥ R will paste the contents of the clipboard as a reference link
- ⌘ ⌥ K inserts a standard inline link, ⌘ ⇧ K inserts an inline image
- ⌘ ⌥ B and ⌘ ⌥ I are bound to bold and italics (Markdown).
- ~ surrounds 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. Thematch_header_hasheswill 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
match_header_hashesoption in your settings to disable. - ⌘ ^ 1 through ⌘ ^ 6 will add the corresponding number of hashmarks for headlines. Works on blank lines and selected text in tandem with the above headline tools. If you select an entire existing headline, the current hashmarks will be removed and replaced with the header level you requested. This command now respects the
match_header_hashespreference setting. - ⌘ ⇧ 6 will insert a footnote and jump to its definition. If your cursor is in a definition, it will jump back to the marker.
- ⌥ ⇧ F will locate footnote markers without definitions and insert the marker for the definition
- ⌥ ⇧ G will do the same for missing reference links
Keymap for Windows and Linux. Most of them are similar with the keymap on Mac OS X.
- Ctrl Win V will paste the contents of the clipboard as an inline link on selected text
- Ctrl Win R will paste the contents of the clipboard as a reference link
- Ctrl Win K inserts a standard inline link, Shift Win K inserts an inline image
- Alt Win B and Alt Win I are bound to bold and italics (Markdown).
- Ctrl 1 through Ctrl 6 will add the corresponding number of hashmarks for headlines. Works on blank lines and selected text in tandem with the above headline tools. If you select an entire existing headline, the current hashmarks will be removed and replaced with the header level you requested. This command now respects the
match_header_hashespreference setting. - Ctrl ⇧ 6 will insert a footnote and jump to its definition. If your cursor is in a definition, it will jump back to the marker.
Footnote commands submitted by J. Nicholas Geist and originated at geekabouttown
Underscores in words doesn't mess with bold or italic style:
Fenced code blocks gets syntax highlighting inside:
Strikethrough is supported:
[TODO]
The preferred method of installation is via Sublime Package Control.
- Install Sublime Package Control
- From inside Sublime Text 2, open Package Control's Command Pallet: CTRL SHIFT P (Windows, Linux) or CMD SHIFT P on Mac.
- Type
install packageand hit Return. A list of available packages will be displayed. - Type
MarkdownEditingand hit Return. The package will be downloaded to the appropriate directory. - Restart Sublime Text 2 to complete installation. Open a Markdown file and this custom theme. The features listed above should now be available.
- Download or clone this repository to a directory
MarkdownEditingin the Sublime Text 2 Packages directory for your platform:- Mac:
git clone https://github.com/ttscoff/MarkdownEditing.git ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/MarkdownEditing - Windows:
git clone https://github.com/ttscoff/MarkdownEditing.git %APPDATA%\Sublime/ Text/ 2/\MarkdownEditing - Linux:
git clone https://github.com/ttscoff/MarkdownEditing.git ~/.Sublime\ Text\ 2/Packages/MarkdownEditing
- Mac:
- Restart Sublime Text 2 to complete installation. Open a Markdown file and this custom theme. The features listed above should now be available.
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
In order to activate the dark theme, put this line to your user settings file of the flavor:
"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-Dark.tmTheme",
If you want to go with your already existing theme, you can reenable it with the same method as dark theme. Keep in mind that, that theme may not cover all the parts of the Markdown syntax that this plugin defines.
When you decide to live with MarkdownEditing plugin, you may want to disable the native Markdown plugin. It's not a requirement but will remove the clutter in your language selection list at bottom right of Sublime Text. To do that, add Markdown to your ignored_packages list in ST user settings:
"ignored_packages": [..., "Markdown"],
A simple reminder: Sublime Text has a Distraction Free mode that's great with Markdown writing. Key binding for it: Shift F11.
MarkdownEditing is released under the MIT License.