From bb77865bc15041442df71f896caf164b74d075e2 Mon Sep 17 00:00:00 2001 From: AdrieanKhisbe Date: Fri, 15 Jan 2016 08:30:43 +0100 Subject: [PATCH 1/3] Add melpa badge to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index b4c0e37..60df726 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ Markdown preview mode =========================== +[![MELPA Stable](http://stable.melpa.org/packages/markdown-preview-mode-badge.svg)](http://stable.melpa.org/#/markdown-preview-mode) +[![MELPA](http://melpa.org/packages/markdown-preview-mode-badge.svg)](http://melpa.org/#/markdown-preview-mode) + > **Markdown realtime preview minor mode** + + ## Description Opens a preview in a browser, updated upon buffer save. From 42e6b6fcf1fdbc8f3a00c84ea330ceb3bc3ab2ba Mon Sep 17 00:00:00 2001 From: AdrieanKhisbe Date: Fri, 15 Jan 2016 08:30:58 +0100 Subject: [PATCH 2/3] Few tweaks to doc --- markdown-preview-mode.el | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/markdown-preview-mode.el b/markdown-preview-mode.el index 41330d6..15efe24 100644 --- a/markdown-preview-mode.el +++ b/markdown-preview-mode.el @@ -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) From 7b4a41929aba055de4753fbf98006a5c12de8389 Mon Sep 17 00:00:00 2001 From: AdrieanKhisbe Date: Fri, 15 Jan 2016 08:37:32 +0100 Subject: [PATCH 3/3] Add melpa install instruction to README --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 60df726..f02678d 100644 --- a/README.md +++ b/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.