chk2 / sublime-strapdown-preview

Markdown preview plugin for Sublime Text 3 using Strapdown.js. No server-side processing is required as Strapdown.js is purely browser-based Markdown converter using Twitter Bootstrap for theming support.

ST3 » Strapdown.js Markdown Preview

Sublime Text 3 plug-in that allows you preview your markdown files in your browser, using beautiful Strapdown.js.

Strapdown.js is mixing some Javascript with Bootstrap (Twitter's HTML5 & CSS framework) to show you beautiful presentation of your Markdown files.

The good thing about Strapdown.js is that resulting HTML, besides looking very good and being themeable, also contains unmodified Markdown content that can be easily edited anywhere and extracted back, if you need it again.

Installation

• recommended is to use use Sublime Package Manager
• press Ctrl+Shift+P then Package Control: Install Package
• look for Strapdown.js Markdown Preview and install it.

Usage

• use Ctrl+Shift+P then Strapdown.js Markdown Preview to launch a preview
• or bind some key in your user key binding, using a line like this one:
  { "keys": ["ctrl+alt+m"], "command": "strapdown_markdown_preview", "args": {"target": "browser"} },

Metadata

You can specify additional attributes on top of your text file / active window. These details can change theme and the title of rendered file. Just add a comment near the start, like this:

<!--
  Title: Strapdown.js Markdown Preview plugin for Sublime Text
  Theme: cerulean
-->

The idea is very similar to YAML Front Matter or MultiMarkdown metadata header block, but it's more in line with Strapdown.js idea. Thus using HTML comment markers as metadata markers.

Metadata can be anywhere in document. If some attribute is specified multiple times, the last value will be used. For now, the only usable attributes are title and theme.

Licence

The code is available at GitHub under MIT licence.