ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Markdown Extended

by jonschlinkert ST2/ST3 Top 100

Top 100 Sublime Text plugin! Markdown syntax highlighter for Sublime Text, with extended support for GFM fenced code blocks, with language-specific syntax highlighting. YAML Front Matter. Works with ST2/ST3. Goes great with Assemble.

Details

  • 2017.03.02.08.34.46
  • github.​com
  • github.​com
  • 3 weeks ago
  • 1 hour ago
  • 4 years ago

Installs

  • Total 142K
  • Win 57K
  • OS X 60K
  • Linux 25K
Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8
Windows 42 97 90 101 81 81 52 52 83 86 83 102 100 45 53 80 83 103 101 83 49 60 84 70 83 108 77 50 55 72 82 77 84 91 53 49 86 93 82 67 80 45 42 61 87 87
OS X 29 60 80 67 56 60 38 47 75 66 75 56 66 45 40 72 73 66 64 63 47 47 63 79 62 69 54 38 33 64 75 64 76 57 31 50 61 58 69 64 66 35 30 61 53 89
Linux 21 35 38 52 25 34 17 23 25 25 29 44 32 23 21 33 29 25 23 27 16 22 32 30 36 20 23 16 16 25 25 35 24 37 32 28 29 31 31 34 44 14 20 27 24 25

Readme

Source
raw.​githubusercontent.​com

sublime-markdown-extended

Extends Soda's Monokai and the default markdown styles with additional syntax highlighting for YAML Front Matter, GitHub Flavored Markdown (GFM) and language-specific syntax highlighting inside GFM “fenced” code blocks

Although substantial changes have been made, thank you @aziz and other contributors to Knockdown, for the code for the fenced code blocks.

Get Monokai Extended for better highlighting.

Jump to Examples ↓

Getting Started

1. Installation

Package Control

If you already have Package Control installed in Sublime Text:

  • Select “Install Package” from the Command Palette: Ctrl+Shift+P on Windows and Linux or ⇧⌘P on OS X)
  • Search for “Markdown Extended” and click enter.

Manual Installation

Go to Preferences -> Browse Packages, and then either download and unzip this plugin into that directory, or:

git clone https://github.com/jonschlinkert/sublime-markdown-extended.git "sublime-markdown-extended"

2. Activate this Language

After installing this package, open a markdown file and switch the language to Markdown Extended, using one of the following methods:

  • Select from the list of supported languages in your status bar at the bottom right corner of your editor
  • ctrl + shift + p and search for “Markdown Extended”

3. Make “Markdown Extended” the default

To make Markdown Extended the default highlighting for the current extension:

  1. Open a file with the extension you want to set a default for (i.e. .md)
  2. Navigate through the following menus in Sublime Text: View -> Syntax -> Open all with current extension as... -> Markdown Extended

Features:

  • Support for YAML Front Matter
  • Support for GFM “fenced” code blocks
  • Language-specific syntax highlighting support inside GFM “fenced” code blocks for most popular languages (see below for the list of supported languages)
  • Syntax highlighting for URLs in text which is auto-linked by GFM
  • Proper syntax highlighting for bullets and numbers in ordered/unordered lists
  • Proper syntax highlighting for bold and italics by ignoring multiple underscores in words

Markdown Enhancements

The following examples use the Monokai Extended theme.

Whitespace

Significant whitespace

Whitespace is significant only directly before and directly after fenced code blocks! Following these instructions will ensure that highlighting works properly and consistently._

This is very simple:

  • Add a newline before and after clode blocks
  • No trailing spaces after the last code block

If you don't, it won't break your code but it won't always look awesome.

Comparisons with and without proper whitespace

Whitespace before the block

You will need to keep a space above and below fenced code blocks for predictable results with syntax highlighting. For example, this is what it looks like when there is no space before a fenced code block:

image

This is what it looks like with proper spacing:

image

Whitespace after the block

Also add a new line after code blocks, but make sure that there is no trailing whitespace next to the bottom fence.

With a trailing whitespace

image

Without a trailing whitespace

image

Supported languages

The following languages are highlighted inside fenced code blocks:

Note that in order for a language to be highlighted properly, you must have the language installed in Sublime Text.

  • coffee|coffeescript
  • coffee front matter
  • cpp
  • csharp
  • css
  • c
  • c++
  • diff
  • ejs
  • erlang
  • underscore
  • go
  • lodash
  • handlebars|hbs: requires the Sublime Text Handlebars package
  • html|html5
  • ini
  • jade
  • java
  • javascript|js
  • json
  • json front matter
  • julia
  • less
  • ls|livescript|LiveScript
  • lua
  • md|markdown
  • nginx
  • objective-c
  • objective-c++
  • perl
  • r
  • ruby
  • sass
  • scala
  • scss
  • shell
  • bash
  • sql|ddl|dml
  • postgresql|postgres|pgsql
  • styl
  • swift
  • swig
  • liquid
  • xml
  • yaml
  • yaml front matter

CSS

Before

image

After

image

LESS

Before

image

After

image

HTML

Before

image

After

image

JavaScript

Before

image

After

image

Coffee

Before

image

After

image

LiveScript

Before

image

After

image

Shell

Before

image

After

image

YAML Front Matter

See gray-matter

Before

image

After

image

Coffee Front Matter

See gray-matter

Before

image

After

image

Authors

Jon Schlinkert

Alexander Krivoshhekov

Copyright and license

Copyright 2013-2015 Jon Schlinkert

MIT License