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 226K
  • Win 110K
  • Mac 78K
  • Linux 38K
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 Jun 27 Jun 26 Jun 25 Jun 24
Windows 17 23 26 26 31 19 22 26 40 20 31 22 17 17 24 22 29 24 22 17 16 17 25 36 27 26 9 19 17 31 33 25 20 13 13 27 24 34 25 26 9 13 19 22 20 19
Mac 12 30 28 24 27 13 9 27 21 27 27 25 13 5 18 38 36 22 22 11 6 35 25 21 26 26 13 14 27 26 35 24 25 8 12 27 29 20 22 22 10 9 21 27 16 18
Linux 2 5 7 13 2 1 2 5 9 4 13 5 4 4 5 6 9 9 7 9 5 10 9 3 7 8 2 3 7 14 5 7 13 6 5 6 10 11 9 7 5 3 4 10 4 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…