hellmund/markdown-preview-mode
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
92 Commits 1 Branch 10 Tags 118 KiB
Emacs Lisp 67.4%
HTML 32.6%
4979e66f27
Go to file
Meik Hellmund 4979e66f27 some css changed
2020-11-10 19:41:12 +01:00
.gitignore Client javascript support: fixes #18 2016-12-05 15:40:52 +02:00
favicon.ico favicon.ico 2016-12-07 18:41:09 +02:00
LICENSE Initial commit 2014-09-13 15:18:59 +03:00
markdown-preview-mode.el fix #32 drop dep on uuidgen; replace with uuid function 2018-12-13 15:39:40 +02:00
preview.html some css changed 2020-11-10 19:41:12 +01:00
README.md preview.html: add css from pandoc, don't use local files for js, add Mathjax.typeset() call 2020-10-25 19:52:17 +01:00

README.md

Markdown preview mode

This is my private fork of https://github.com/ancane/markdown-preview-mode

!the contents of this readme may still apply or not!

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 preview 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.
  • customize-option markdown-preview-auto-open - change the way preview window is open.

Remote access

  • Customize markdown-preview-host to 0.0.0.0.
  • Customize markdown-preview-http-host to 0.0.0.0.
  • Set markdown-preview-auto-open to nil to disable window opening at remote emacs server.
  • Start markdown-preview-mode. Http link for preview will be printed to *Messages* buffer. If not - run markdown-preview-open-browser to get the link printed.
  • Setup 2 tunnels for 0.0.0.0:7379 and 0.0.0.0:9000 and then open preview link in local browser. Adjust tunnels according to your custom ws-port and http-port settings.

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

(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