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

Markdown​Live​Preview

by math2001 ST3 Top 100

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

Labels markdown, preview

Details

Installs

  • Total 253K
  • Win 120K
  • Mac 92K
  • Linux 41K
Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28
Windows 20 47 36 17 32 37 57 51 46 54 10 27 33 55 49 49 42 29 22 55 57 55 50 49 27 24 36 42 49 54 45 16 21 43 46 48 58 60 30 20 38 50 46 36 49 21
Mac 15 51 56 29 20 45 65 67 75 61 23 29 64 48 61 67 65 31 34 60 57 84 84 83 34 26 65 80 73 81 67 31 28 73 84 85 75 73 27 39 54 54 69 99 70 29
Linux 2 19 14 12 8 13 13 20 18 16 12 5 7 15 17 14 21 7 4 11 14 16 17 15 12 11 12 14 14 11 11 11 11 21 26 18 21 14 4 5 10 9 17 13 17 10

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…