2014-09-14 11:18:24 +02:00
|
|
|
Markdown preview mode
|
2014-09-13 14:19:34 +02:00
|
|
|
===========================
|
|
|
|
|
|
2016-01-15 08:30:43 +01:00
|
|
|
[](http://stable.melpa.org/#/markdown-preview-mode)
|
|
|
|
|
[](http://melpa.org/#/markdown-preview-mode)
|
|
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
Markdown preview in emacs features:
|
2016-01-10 15:01:10 +01:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
* on save/idle preview update
|
|
|
|
|
* scroll sync
|
|
|
|
|
* custom/extra css and javascript
|
|
|
|
|
* remote preview
|
|
|
|
|
* multiple simultaneous previews
|
2014-09-14 11:18:24 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
## Install
|
2016-01-11 10:47:02 +01:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
* `package-install markdown-preview-mode`
|
|
|
|
|
* `el-get-install markdown-preview-mode`
|
2014-09-14 16:41:52 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
## Run
|
2014-09-14 16:41:52 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
* `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).
|
2014-09-14 16:41:52 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
## Customize
|
2014-09-14 16:41:52 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
* `customize-option markdown-command` - change markdown processor.
|
|
|
|
|
* `customize-option` [browse-url-browser-function](http://www.emacswiki.org/emacs/BrowseUrl) - select different 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.
|
2014-09-14 16:41:52 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
## Extra css
|
2014-09-15 21:39:14 +02:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
### Add extra css to default solarized dark theme
|
2016-12-11 13:04:36 +01:00
|
|
|
```lisp
|
|
|
|
|
(add-to-list 'markdown-preview-stylesheets "https://raw.githubusercontent.com/richleland/pygments-css/master/emacs.css")
|
|
|
|
|
```
|
2016-12-11 23:37:22 +01:00
|
|
|
### Override theme completely with
|
2016-12-11 13:04:36 +01:00
|
|
|
|
|
|
|
|
```lisp
|
|
|
|
|
(setq markdown-preview-stylesheets (list "http://thomasf.github.io/solarized-css/solarized-light.min.css"))
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Extra javascript
|
2016-12-05 14:40:52 +01:00
|
|
|
|
2016-12-11 23:37:22 +01:00
|
|
|
### Add MathJax
|
2016-12-05 14:40:52 +01:00
|
|
|
|
|
|
|
|
```lisp
|
|
|
|
|
(add-to-list 'markdown-preview-javascript "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML")
|
|
|
|
|
```
|
2016-12-11 23:37:22 +01:00
|
|
|
### async
|
2016-12-05 14:40:52 +01:00
|
|
|
|
|
|
|
|
```lisp
|
|
|
|
|
(add-to-list 'markdown-preview-javascript '("http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML" . async))
|
|
|
|
|
```
|
|
|
|
|
|
2016-01-15 08:37:32 +01:00
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
* [markdown-mode.el](https://github.com/defunkt/markdown-mode)
|
|
|
|
|
* [websocket.el](https://github.com/ahyatt/emacs-websocket)
|
2016-12-11 23:37:22 +01:00
|
|
|
* [web-server.el](https://github.com/eschulte/emacs-web-server)
|
