Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ngarnier authored Dec 6, 2016
1 parent 61fdfcc commit b58849c
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# mjml-preview package
# MJML Preview Package

A short description of your package.
Show the rendered HTML from MJML on the right pane of the editor. It is enabled for `.mjml` files.

![A screenshot of your package](https://f.cloud.github.com/assets/69169/2290250/c35d867a-a017-11e3-86be-cd7c5bf3ff9b.gif)
![mjml-preview](http://i.imgur.com/o6Y3q6f.png)

To toggle the preview, go to "Packages" > "mjml-preview" > "Preview MJML".

## Trigger on Save

To refresh the preview pane on each save, tick the box "Trigger on Save" in the settings of the package: <kbd>⌘+,</kbd> or <kbd>ctrl+,</kbd> to open package settings > look for "mjml-preview" in "installed packages" > "Settings" > "Trigger on Save".

![settings](http://i.imgur.com/R17UQmQ.png)

0 comments on commit b58849c

Please sign in to comment.