commit
c8805027d7
27
README.md
27
README.md
@ -1,6 +1,9 @@
|
||||
Markdown preview mode
|
||||
===========================
|
||||
|
||||
[](http://stable.melpa.org/#/markdown-preview-mode)
|
||||
[](http://melpa.org/#/markdown-preview-mode)
|
||||
|
||||
> **Markdown realtime preview minor mode**
|
||||
|
||||
## Description
|
||||
@ -9,14 +12,6 @@ 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.
|
||||
|
||||
## Dependencies
|
||||
|
||||
* [markdown-mode.el](https://github.com/defunkt/markdown-mode)
|
||||
* [websocket.el](https://github.com/ahyatt/emacs-websocket)
|
||||
|
||||
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've 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`.
|
||||
@ -45,6 +40,20 @@ and specify a URL to your favourite markdown css file.
|
||||
|
||||
Adjustable by `M-x customize-option` -> `markdown-preview-port`.
|
||||
|
||||
## el-get
|
||||
## Installation
|
||||
### Melpa
|
||||
|
||||
*Melpa* recipe is available, so `markdown-preview-mode` is just a `package-install` away!
|
||||
|
||||
### el-get
|
||||
* `M-x el-get-self-update`
|
||||
* `M-x el-get-install` -> `markdown-preview-mode`
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
* [markdown-mode.el](https://github.com/defunkt/markdown-mode)
|
||||
* [websocket.el](https://github.com/ahyatt/emacs-websocket)
|
||||
|
||||
Makes use of `markdown-mode`, which already can transform markdown into html
|
||||
and `websocket.el` to deliver html to browser.
|
||||
|
@ -35,7 +35,7 @@
|
||||
(require 'markdown-mode)
|
||||
|
||||
(defgroup markdown-preview nil
|
||||
"Markdown preview mode"
|
||||
"Markdown preview mode."
|
||||
:group 'text
|
||||
:prefix "markdown-preview-"
|
||||
:link '(url-link "https://github.com/ancane/markdown-preview-mode"))
|
||||
@ -45,7 +45,8 @@
|
||||
:group 'markdown-preview
|
||||
:type 'integer)
|
||||
|
||||
(defcustom markdown-preview-style "http://thomasf.github.io/solarized-css/solarized-dark.min.css"
|
||||
(defcustom markdown-preview-style
|
||||
"http://thomasf.github.io/solarized-css/solarized-dark.min.css"
|
||||
"Markdown preview style URI."
|
||||
:group 'markdown-preview
|
||||
:type 'string)
|
||||
|
Loading…
Reference in New Issue
Block a user