Add melpa install instruction to README
This commit is contained in:
parent
42e6b6fcf1
commit
7b4a41929a
26
README.md
26
README.md
@ -6,22 +6,12 @@ Markdown preview mode
|
||||
|
||||
> **Markdown realtime preview minor mode**
|
||||
|
||||
|
||||
|
||||
## Description
|
||||
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`.
|
||||
@ -50,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.
|
||||
|
Loading…
Reference in New Issue
Block a user