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

Markdown​Live​Preview

by math2001 ST3 Trending Top 100

A Sublime Text 3 plugin to preview your markdown as you type

Labels markdown, preview

Details

Installs

  • Total 239K
  • Win 115K
  • Mac 85K
  • Linux 39K
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 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1
Windows 44 45 45 30 19 49 44 49 48 50 16 21 39 46 49 37 54 30 30 37 40 41 44 38 20 10 31 24 33 19 25 11 13 35 44 31 35 29 12 16 31 34 43 39 41 18
Mac 58 89 100 38 40 73 80 52 69 74 28 29 66 72 67 81 75 30 36 72 73 66 58 45 29 29 47 53 48 48 39 27 23 57 44 50 65 57 24 29 50 44 52 50 45 22
Linux 7 17 11 9 8 12 14 12 15 13 9 6 17 12 11 11 18 10 10 14 12 14 14 9 3 15 10 4 14 4 13 10 9 12 12 17 17 13 9 8 11 10 12 12 10 3

Readme

Source
raw.​githubusercontent.​com

MarkdownLivePreview

A simple plugin to preview your markdown as you type right in Sublime Text. No dependencies!

How to install

It's available on package control!

Setting a keybinding

The open the preview, you can search up in the command palette (ctrl+shift+p) MarkdownLivePreview: Open Preview. But if you prefer to have a shortcut, add this to your keybindings file:

{
    "keys": ["alt+m"],
    "command": "open_markdown_preview"
}

How to contribute

If you know what feature you want to implement, or what bug you wanna fix, then go ahead and hack! Maybe raise an issue before hand so that we can talk about it if it's a big feature.

But if you wanna contribute just to say thanks, and don't really know what you could be working on, then there are a bunch of FIXMEs all over this package. Just pick one and fix it :-)

$ git clone https://github.com/math2001/MarkdownLivePreview
$ cd MarkdownLivePreview
$ grep -R FIXME

Hack it!

  1. Fork this repo
  2. Make your own branch (the name of the branch should be the feature you are implementing eg. improve-tables, fix-crash-on-multiple-preview
  3. All your code should be formated by black.
  4. Send a PR!

Known limitations

Numbered lists are rendered as unordered lists

Error: language “md” is not supported
1. first
2. second
3. third

will be previewed the exact same way as

Error: language “md” is not supported
- first
- second
- third

The issue comes from Sublime Text's minihtml which doesn't support ordered lists. If you think feel like implementing a workaround, feel free to contribute, but it's not something I'm planning on doing. It isn't a critical feature, and support should come with time…