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

Markdown​Live​Preview

by math2001 ST3

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

Labels markdown, preview

Details

Installs

  • Total 158K
  • Win 76K
  • Mac 55K
  • Linux 28K
Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12
Windows 35 63 48 20 22 47 38 44 35 34 36 25 25 32 52 54 36 21 52 49 30 35 27 21 21 15 36 47 50 44 46 35 30 36 51 33 36 25 27 30 53 49 59 71 44 16
Mac 18 33 36 23 22 26 41 30 34 34 8 14 17 27 34 29 29 8 33 27 26 33 16 24 18 12 13 37 25 34 34 26 13 32 27 38 23 24 13 13 31 39 34 29 38 12
Linux 7 9 10 5 9 8 13 25 13 19 6 5 6 11 9 10 19 5 15 17 14 15 16 16 6 8 10 10 16 15 18 7 7 21 15 12 10 18 13 13 16 14 13 22 20 5

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…