Go to file

Igor Shymko 5c83d5fde6 json code style		2014-10-23 19:04:13 +03:00
.gitignore	Initial commit	2014-09-13 15:18:59 +03:00
LICENSE	Initial commit	2014-09-13 15:18:59 +03:00
README.md	typo fix	2014-10-03 22:40:26 +03:00
markdown-preview-mode.el	preview window is scrolling according to cursor position in markdown buffer	2014-10-23 02:14:12 +03:00
markdown-preview-mode.rcp	rcp deps fix	2014-09-14 18:07:56 +03:00
preview.html	json code style	2014-10-23 19:04:13 +03:00

README.md

Markdown preview mode

Description

Opens a preview in a browser, updated upon buffer save. Same preview window is valid across multiple mardown buffers.

Dependencies

markdown-mode.el
websocket.el

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

Usage

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.

Multimarkdown

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.

Browser

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.

Theme

Solarized-dark

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.