How can I preview markdown in Emacs in real time?
EmacsMarkdownEmacs Problem Overview
I'm using spacemacs and I'm looking for a plugin to preview markdown in real time. I have found a plugin markdown-preview-eww, but it requires a gem and I prefer not to install ruby.
The markdown-mode just exports md to html, and it can't preview markdown in real time. Also, I don't like to generate any file without my agreement.
So, is there any plugin to preview markdown in emacs? Or does everyone use org-mode in emacs rather than markdown?
Emacs Solutions
Solution 1 - Emacs
There are a few solutions listed here: http://wikemacs.org/wiki/Markdown#Live_preview_as_you_type.
The pure-Emacs (nearly) solution and easy one, requiring no extra library from Python or Nodejs, is impatient-mode.
Impatient-mode
It's designed to work with html but the doc gives a trick to make it work with markdown. It also works like a charm but requires one configuration step:
- Install impatient-mode with
M-x package-install RET impatient-mode RET, given you have configured package.el to use the melpa repository. - Start an emacs' web server with
M-x httpd-start. - Start impatient mode in the buffers you're interested to live preview:
M-x impatient-mode. - Open your browser to localhost:8080/imp. You'll see the list of buffers with the mode enabled. Click on one: you see live rendering of the buffer.
To enable markdown conversion, we follow wikemacs:
-
Define this elisp function somewhere, like in your init file:
<!-- language: lang-lisp --> (defun markdown-html (buffer) (princ (with-current-buffer buffer (format "<!DOCTYPE html><html><title>Impatient Markdown</title><xmp theme=\"united\" style=\"display:none;\"> %s </xmp><script src=\"http://strapdownjs.com/v/0.2/strapdown.js\"></script></html>" (buffer-substring-no-properties (point-min) (point-max)))) (current-buffer))) -
Tell impatient mode to use it:
M-x imp-set-user-filter RET markdown-html RET. -
Go back to your browser, it works!
livedown-mode (with npm)
https://github.com/shime/emacs-livedown requires the livedown npm package. Also, this emacs package is not in MELPA, you have to clone it locally. Otherwise, it is a good and lightweight solution.
Vmd-mode (npm, Electron)
Another solution is vmd-mode, which works with the vmd node package. This is not the most heavy-weight solution: vmd is based on Electron (!).
Grip-mode (Python, Github's rate limit)
Another one is grip-mode, that relies on a Python package:
pip install --user grip
M-x package-install grip-mode
Then run M-x grip-mode in the markdown buffer. It opens a new tab in your browser.
Unfortunately, at the time of writing, it is limited by Github's rate limit. Indeed, to render content as precisely as Github, it calls its API. It doesn't render content locally. As such we are limited to 60 calls an hour, which is very few. See this issue: https://github.com/joeyespo/grip/issues/35
Solution 2 - Emacs
I like this simpler approach that doesn't require another package nor a browser:
-
Execute
M-x markdown-other-windowon current buffer and display the result in other window. -
Change to
M-x html-modeand hide HTML tagsM-x sgml-tags-invisible.
Then to update the html buffer run again markdown-other-window C-c C-c m on the markdown buffer.
Solution 3 - Emacs
You can now do this in Spacemacs with markdown-live-preview-mode or SPC m c p.
Solution 4 - Emacs
I would like recommend grip-mode: Instant Github-flavored Markdown/Org preview.
Solution 5 - Emacs
Before following the steps in this answer, you would need to have a markdown parser installed on your system and a major mode to associate it to, in emacs.
Add emacs package repository to init.el
(require 'package)
(add-to-list 'package-archives
'("melpa-stable" . "https://stable.melpa.org/packages/"))
(package-initialize)
Restart emacs and refresh packages:
M-x package-refresh-contents
Install emacs major mode markdown-mode by evaluating:
M-x package-install RET markdown-mode RET
Install markdown processor:
brew install pandoc
OR
sudo apt-get install pandoc
Map the markdown parser to the major-mode in ~/.emacs.d/init.ellike:
(custom-set-variables
'(markdown-command "/usr/local/bin/pandoc"))
Solution 6 - Emacs
@Ehvince's answer inspired me to a little bit change the markdown-html function to provide exactly the same view as in Github.com.
(defun markdown-html (buffer)
(princ (with-current-buffer buffer
(format "<!DOCTYPE html><html><script src=\"https://cdnjs.cloudflare.com/ajax/libs/he/1.1.1/he.js\"></script><link rel=\"stylesheet\" href=\"https://assets-cdn.github.com/assets/github-e6bb18b320358b77abe040d2eb46b547.css\"><link rel=\"stylesheet\" href=\"https://assets-cdn.github.com/assets/frameworks-95aff0b550d3fe338b645a4deebdcb1b.css\"><title>Impatient Markdown</title><div id=\"markdown-content\" style=\"display:none\">%s</div><div class=\"markdown-body\" style=\"max-width:968px;margin:0 auto;\"></div><script>fetch('https://api.github.com/markdown', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ \"text\": document.getElementById('markdown-content').innerHTML, \"mode\": \"gfm\", \"context\": \"knit-pk/homepage-nuxtjs\"}) }).then(response => response.text()).then(response => {document.querySelector('.markdown-body').innerHTML = he.decode(response)}).then(() => { fetch(\"https://gist.githubusercontent.com/FieryCod/b6938b29531b6ec72de25c76fa978b2c/raw/\").then(response => response.text()).then(eval)});</script></html>"
(buffer-substring-no-properties (point-min) (point-max))))
(current-buffer)))
Function which enables the impatient mode and automatically sets the imp-user-filter to markdown-html.
(defun markdown-preview-like-god ()
(interactive)
(impatient-mode 1)
(setq imp-user-filter #'markdown-html)
(cl-incf imp-last-state)
(imp--notify-clients))
How to use:
M-x http-start- On .md buffer
M-x markdown-preview-like-god - Go to
localhost:8080/imp
Solution 7 - Emacs
You can use my emacs application framework: https://github.com/manateelazycat/emacs-application-framework
It's embed browser in your emacs, then you can write markdown at left side and preview update at right side.
Screenshot at: https://github.com/manateelazycat/emacs-application-framework/blob/master/screenshot/markdown_previewer.gif
How to install eaf please look https://github.com/manateelazycat/emacs-application-framework/blob/master/README.md