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

Markdown​Live​Preview

by math2001 ST3 Trending

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

Labels markdown, preview

Details

Installs

  • Total 219K
  • Win 107K
  • Mac 76K
  • Linux 37K
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 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8
Windows 1 26 21 27 27 25 20 13 29 32 24 26 23 15 18 16 27 29 18 18 16 11 19 13 21 17 20 8 11 13 25 33 21 23 6 7 27 34 26 29 29 8 11 26 22 23
Mac 0 27 21 20 16 27 18 11 19 23 27 21 24 10 8 18 22 24 20 17 11 9 12 10 17 18 9 17 11 11 17 19 13 24 5 7 17 13 12 21 24 5 9 17 14 16
Linux 2 7 13 10 18 9 5 6 11 10 10 6 7 4 7 8 10 9 9 7 6 4 2 9 7 8 6 7 4 6 9 9 8 10 7 7 4 9 11 9 5 4 5 6 6 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…