Go to file
Igor Shymko 7fb0f3bd11 Open browser preview via http call 2016-12-07 00:43:39 +02:00
.gitignore Client javascript support: fixes #18 2016-12-05 15:40:52 +02:00
LICENSE Initial commit 2014-09-13 15:18:59 +03:00
README.md Client javascript support: fixes #18 2016-12-05 15:40:52 +02:00
markdown-preview-mode.el Open browser preview via http call 2016-12-07 00:43:39 +02:00
preview.html Client javascript support: fixes #18 2016-12-05 15:40:52 +02:00


Markdown preview mode



Opens a preview in a browser, updated upon buffer save.

Same preview window is valid across multiple markdown buffers. Scrolls browser window to keep your editing position visible.


M-x markdown-preview-mode will open preview in a browser and will start markdown-mode if it's not yet running for current buffer. If you've closed the preview window, you can start it over with M-x markdown-preview-open-browser. All websockets will be cleaned up on emacs termination. If you'd like to perform cleanup manually run M-x markdown-preview-cleanup.


In order to enable multimarkdown support, customize M-x customize-option -> markdown-command variable. Look for Markdown Command which is set to markdown by default, set to multimarkdown and make sure it's in your PATH.


In order to select preferred browser, customize M-x customize-option -> browse-url-browser-function option. Select your browser from Value menu. If it's not there, follow EmacsWiki: Browse Url.



In order to change preview styling, run M-x customize-option -> markdown-preview-style and specify a URL to your favourite markdown css file.

Client javascript

If you'd like to include additional javascript for the preview, add this to your init:

(add-to-list 'markdown-preview-javascript "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML")

or, to make it async:

(add-to-list 'markdown-preview-javascript '("http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML" . async))

Websocket port

Adjustable by M-x customize-option -> markdown-preview-port.



Melpa recipe is available, so markdown-preview-mode is just a package-install away!


  • M-x el-get-self-update
  • M-x el-get-install -> markdown-preview-mode


Makes use of markdown-mode, which already can transform markdown into html and websocket.el to deliver html to browser.