Go to file
Igor Shymko 3a0b2cb8de Doc update: more explicit dependency on markdown-mode command; fixes #21 2016-12-18 21:55:52 +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 Doc update: more explicit dependency on markdown-mode command; fixes #21 2016-12-18 21:55:52 +02:00
favicon.ico favicon.ico 2016-12-07 18:41:09 +02:00
markdown-preview-mode.el text frame check 2016-12-12 00:43:47 +02:00
preview.html Support multiple preview from same http port 2016-12-11 18:44:45 +02:00

README.md

Markdown preview mode

MELPA Stable MELPA

Markdown preview in emacs features:

  • on save/idle preview update
  • scroll sync
  • custom/extra css and javascript
  • remote preview
  • multiple simultaneous previews

Install

  • package-install markdown-preview-mode
  • el-get-install markdown-preview-mode

Markdown processor

markdown-preview-mode depends on markdown-mode for markdown processor, defined by markdown-command and it is markdown by default. Please, make sure it is in your $PATH.

Run

  • markdown-preview-mode - start mode and open preview window.
  • markdown-preview-open-browser - open priview window for current buffer.
  • markdown-preview-cleanup - cleanup running processes (close websocket and http servers).

Customize

  • customize-option markdown-command - change markdown processor; take a look at multimarkdown
  • customize-option browse-url-browser-function - change the browser.
  • customize-option markdown-preview-host - change http/websocket server address.
  • customize-option markdown-preview-ws-port - change websocket server port.
  • customize-option markdown-preview-http-port - change http server port.

Extra css

Add extra css to default solarized dark theme

(add-to-list 'markdown-preview-stylesheets "https://raw.githubusercontent.com/richleland/pygments-css/master/emacs.css")

Override theme completely with

(setq markdown-preview-stylesheets (list "http://thomasf.github.io/solarized-css/solarized-light.min.css"))

Extra javascript

Add MathJax

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

async

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

Dependencies