Go to file
2016-01-11 05:53:03 +01:00
.gitignore Initial commit 2014-09-13 15:18:59 +03:00
LICENSE Initial commit 2014-09-13 15:18:59 +03:00
markdown-preview-mode.el Replace prefix to follow elisp conventions 2016-01-11 05:53:03 +01:00
preview.html style customization fix 2015-06-20 21:52:50 +03:00
README.md Add link and subtitle 2016-01-10 15:01:10 +01:00

Markdown preview mode

Markdown realtime preview minor 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.


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


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'v 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 prefered 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.

Websocket port

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


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