Markdown

2017-02-02T06:01:46Z

61.19.193.211: /* Live preview as you type */

Markdown

2017-01-31T23:57:13Z

61.19.193.211: /* Generate a table of content */

{{Infobox major-mode
|title=Markdown
|library=markdown-mode
|command=markdown-mode
|builtin=no
}}

[http://jblevins.org/projects/markdown-mode/ Markdown Mode] provides a major mode for editing [https://en.wikipedia.org/wiki/Markdown Markdown]-formatted text files.

This package is not currently part of the Emacs distribution.

Hello!

== Live preview as you type ==

There are a few possibilities.

=== flymd ===

That may be the easiest one. Install [https://github.com/mola-T/flymd flymd] (in [[melpa]]), go to your markdown buffer and call '''M-x flymd-flyit'''. It opens a browser window with your markdown being updated live.

It also knows Github Flavoured Markdown.

If you have a problem with scrolling the page, just click on "Auto scroll" in the browser (the red link on the right).

Or look at impatient-mode below, which also works for html.

=== Impatient-mode ===

See [https://github.com/skeeto/impatient-mode impatient-mode] (in MELPA). It only depends on emacs packages. This package is designed for html though, but it is possible to make it render markdown. Evaluate this somewhere so you have the function:

(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)))

Then '''M-x imp-set-user-filter''' in your markdown buffer, and supply markdown-html when it asks for the function. Live updating markdown!

Another filter which cooperates markdown-mode:

(defun markdown-filter (buffer)
(princ
(with-temp-buffer
(let ((tmpname (buffer-name)))
(set-buffer buffer)
(set-buffer (markdown tmpname)) ; the function markdown is in `markdown-mode.el'
(buffer-string)))
(current-buffer)))

=== Livedown-mode ===

[https://github.com/shime/emacs-livedown livedown] is specific to markdown but it requires nodejs packages (to be easily installed with npm).

=== Realtime-preview ===

[https://github.com/niku/realtime-preview.el realtime-preview.el] requires a ruby package (''redcarpet''). Then it does the rendering in [[EWW]], which is embedded in Emacs24.4.

= See also =

== Pandoc-mode ==

[http://pandoc.org/ Pandoc] is a swiss-army knife to convert a mark-up format into another (markdown to rst, org, etc) and [https://github.com/joostkremers/pandoc-mode pandoc-mode] (in melpa) is an emacs interface to it.

= External Links =

* [http://jblevins.org/projects/markdown-mode/ Markdown Mode Project]
* [http://jblevins.org/git/markdown-mode.git Source (git)]

[[Category:Markup languages]][[Category:Document authoring]]

WikEmacs - User contributions [en]

Markdown

Markdown