/MarkdownEditing

Powerful Markdown package for Sublime Text with better syntax understanding and good color schemes.

Primary LanguagePythonMIT LicenseMIT

MarkdownEditing

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.

MarkdownEditing

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

Overview

Installation

You can install MarkdownEditing either from Package Control (recommended) or manually. Package Control automatically download the package and keeps it up-to-date. Manual installation is required if you need to tweak the code.

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"],

Getting "Error loading syntax file..."? See this.

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. In Sublime Text, open the menu "Preferences" -> "Browse Packages...". This is the Sublime Text Packages directory.
  2. Download and unzip or clone this repository to a directory MarkdownEditing in the Sublime Text Packages directory.
  3. The folder structure should look like .../Sublime Text 3/Packages/MarkdownEditing/[files].
  4. Restart Sublime Text to complete installation. Open a Markdown file. The features listed below should now be available.

Features

You can access most features through Command Palette. You can launch it from Tools -> Command Palette.... MarkdownEditing commands start with MarkdownEditing:. And they are only visible when a markdown file is open and active.

  • Pairing
    • 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. So entering ` will expand to `(cursor here)`.
  • List
    • 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 will continue with a new blank task.
  • Blockquote
    • 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.
  • Link
    • 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.
    • If you leave the cursor on a link, you can right click and jump between reference and url.
  • Navigation
    • Displays Markdown headers in the Project Symbol List (Goto -> Goto Symbol in Project...). 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 #.
    • Headers also appear in Document Symbol List (Goto -> Goto Symbol...)
    • You can fold current section with Ctrl Tab
    • You can navigate between adjacent headers with Find Next(Previous) Heading command.
  • Strikethrough
    • ~ wraps selected text with ~~ (strikethrough). When you for instance select the word "foo" and hit ~, the result will be ~~foo~~.
  • Header
    • 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

OS X Windows/Linux Description
⌘⌥V CtrlWinV Creates or pastes the contents of the clipboard as an inline link on selected text.
⌘⌥R CtrlWinR Creates or pastes the contents of the clipboard as a reference link.
⌘⇧K ShiftWinK Creates or pastes the contents of the clipboard as an inline image on selected text.
⌘⌥B ⌘⌥I AltB AltI These are bound to bold and italic. They work both with and without selections. If there is no selection, they will just transform the word under the cursor. These keybindings will unbold/unitalicize selection if it is already bold/italic.
⌘^1...6 Ctrl1...6 These 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 respects the mde.match_header_hashes preference setting.
⌥⇧6 AltShift6 Inserts a footnote.
⇧Tab ShiftTab Fold/Unfold current section.
^⇧Tab CtrlShiftTab Fold all sections under headings of a certain level.
⌘⌥PageUp ⌘⌥PageDown CtrlAltShiftPageUp CtrlAltShiftPageDown Go to the previous/next heading of the same or higher level
⌘⇧PageUp ⌘⇧PageDown CtrlShiftPageUp CtrlShiftPageDown Go to the previous/next heading

GFM Specific Features

GFM means GitHub Flavored Markdown is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. It has some unique features:

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

underscore-in-words

Fenced code blocks gets syntax highlighting inside:

fenced-code-block

Keyboard shortcuts gets highlighted like in GitHub:

keyboard-shortcut

Strikethrough is supported:

strikethrough

Commands for Command Palette

You can launch Command Palette from Tools -> Command Palette.... MarkdownEditing commands start with MarkdownEditing:. And they are only visible when a markdown file is open and active.

General Commands

  • 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.
  • Markdown Lint Performs lint on current Markdown file. See lint rules. Some of the linting rules are customizable via user settings file.
  • Change color scheme... Lists built-in Markdown color schemes for you to preview and use.
  • Switch List Bullet Type Switches the highlighted list between numbered and bulleted style.

Links, References and Footnotes

  • 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.
  • 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.

Folding and Navigation

Remeber you can Ctrl R (in document) and Ctrl Shift R (project-wise) for quick navigation for all headers.

  • Toggle Folding Current Section Folds/unfolds current section.
  • Fold Level 1-4 Sections Fold all sections under headers of specific level.
  • Fold/Unfold All Sections Self explanatory.
  • Find Next/Previous Heading You have option to find just same or higher level or any level

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:

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 Browser" and you will get a WYSIWYG editor.

Troubleshooting

Error loading syntax file...

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).

Roll back to an older version

When you notice any undesired behavior introduced by the latest update, your feedback is always welcome in our issue page. However before it's fixed, you can rollback to an earlier version. Find the desired version and download the zip file, then follow manual installation guide

Related Plugins

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:

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.

License

MarkdownEditing is released under the MIT License.