Markup Preview

A Sublime Text 3 package for rendering markdown in a browser - updates and serves HTML as you type!

Quick Setup:

The Asciidoctor RubyGem is a prerequisite for .adoc files:

gem install asciidoctor

Installing through Package Control

Installing via Package Control will keep OmniMarkupPreviewer up-to-date automatically.

Once Package Control is installed, restart Sublime Text.

1. Open the Command Palette (Ctrl+Shift+P on Windows and Linux. ⌘+⇧+P on OS X).
2. Type "Add" and select "Add Repository".
3. Paste the repository URL https://github.com/bsmith-n4/N4-MarkupPreview into the form at the bottom of the window.
4. Open the Command Palette, type "Install" and select "Package Control: Install Package".
5. Type "N4" and select "N4-MarkupPreview" from list.

Manual Git Install

Clone this repo into your Sublime Text Packages directory:

git clone git://github.com/bsmith-n4/N4-MarkupPreview.git

The 'Packages' directory for Sublime Text 3 is located at:

• Windows: %APPDATA%\Sublime Text 3\Packages\
• Linux: ~/.config/sublime-text-3/Packages/
• OS X: ~/Library/Application Support/Sublime Text 3/Packages/

Key Bindings

OSX:

• ⌘+⌥+O: Preview Markup in Browser.
• ⌘+⌥+X: Export Markup as HTML.
• Ctrl+Alt+C: Copy Markup as HTML.

Windows, Linux:

• Ctrl+Alt+O: Preview Markup in Browser.
• Ctrl+Alt+X: Export Markup as HTML.
• Ctrl+Alt+C: Copy Markup as HTML.

Supported Languages / Syntaxes

The previewer has builtin support for the following markups:

• Markdown
• reStructuredText
• WikiCreole
• Textile
• Pod (Requires Perl >= 5.10 and can be found in PATH, if the perl version < 5.10, Pod::Simple should be installed from CPAN.)
• RDoc (Requires ruby in your PATH)
• Org Mode (Requires ruby, and gem org-ruby should be installed)
• MediaWiki (Requires ruby, as well as gem wikicloth)
• AsciiDoc (Requires ruby, as well as gem asciidoctor)
• Literate Haskell

Acknowledgement

Based on OmniMarkupPreviewer by Timon Wong