Markdown

From WikEmacs
Jump to navigation Jump to search

Markdown Mode provides a major mode for editing Markdown-formatted text files.

Markdown
Library markdown-mode
Command markdown-mode
Builtin no


This package is not currently part of the Emacs distribution.

Nice blog! Is your theme custom made or did you download it from somewhere? A theme like yours with a few simple tweeks would really make my blog stand out. Please let me know where you got your design. Bless you bdcdedbdfadccbfg

Live preview as you type

There are a few possibilities.

flymd

That may be the easiest one. Install 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 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

livedown is specific to markdown but it requires nodejs packages (to be easily installed with npm).

Realtime-preview

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

Pandoc is a swiss-army knife to convert a mark-up format into another (markdown to rst, org, etc) and pandoc-mode (in melpa) is an emacs interface to it.

External Links