Markdown Preview

Preview and build your markdown files quickly in your web browser using Sublime Text 3.

You can use the builtin Python Markdown parser (offline) or use the GitHub Markdown API or GitLab Markdown API (online) for the conversion.

Installation

By Package Control

1. Download & Install Sublime Text 3 (https://www.sublimetext.com/3)
2. Go to the menu Tools -> Install Package Control, then, wait few seconds until the installation finishes up
3. Now, Go to the menu Preferences -> Package Control
4. Type Add Channel on the opened quick panel and press Enter
5. Then, input the following address and press Enter

   https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json
   

6. Go to the menu Tools -> Command Palette... (Ctrl+Shift+P)
7. Type Preferences: Package Control Settings – User on the opened quick panel and press Enter
8. Then, find the following setting on your Package Control.sublime-settings file:

   "channels":
   [
       "https://packagecontrol.io/channel_v3.json",
       "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
   ],

9. And, change it to the following, i.e., put the https://raw.githubusercontent... line as first:

   "channels":
   [
       "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
       "https://packagecontrol.io/channel_v3.json",
   ],

   • The https://raw.githubusercontent... line must to be added before the https://packagecontrol.io... one, otherwise, you will not install this forked version of the package, but the original available on the Package Control default channel https://packagecontrol.io...
10. Now, go to the menu Preferences -> Package Control
11. Type Install Package on the opened quick panel and press Enter
12. Then, search for MarkdownPreview and press Enter

See also:

1. ITE - Integrated Toolset Environment
2. Package control docs for details.

Features

• Markdown preview using the python-markdown with syntax highlighting via Pygments and optional 3rd party extensions (pymdown-extensions included by default).
• Markdown previews via the GitHub API.
• Markdown previews via the GitLab API thanks to @hadisfr.
• Ability use other external Markdown parsers.
• Build markdown file using Sublime Text build system.
• Browser preview auto reload on save if you have the LiveReload plugin installed.
• Configurable CSS and JavaScript assets with overriding if needed.
• YAML support thanks to @tommi.
• Clipboard selection and copy to clipboard thanks to @hexatrope.
• MathJax support : \(\frac{\pi}{2}\) thanks to @bps10.
• HTML template customization thanks to @hozaka.
• Embed images as base64.
• Strip out MultiMarkdown CriticMarkup.

Documentation

https://facelessuser.github.io/MarkdownPreview/

Support

• Any bugs about Markdown Preview please feel free to report here.
• And you are welcome to fork and submit pull requests.

Attribution

Markdown Preview contains a stripped down version of font awesome that is included in the default non-GitHub CSS. It contains only the icons we currently use.

https://fontawesome.com/license

License

The code is available at GitHub under the MIT license.