1 # Emacs Markdown Mode [![MELPA badge][melpa-badge]][melpa-link] [![MELPA stable badge][melpa-stable-badge]][melpa-stable-link] [![Github Actions Status][github-actions-badge]][github-actions-link] [![Guide to Markdown Mode for Emacs][leanpub-badge]][leanpub-link]
3 [melpa-link]: https://melpa.org/#/markdown-mode
4 [melpa-stable-link]: https://stable.melpa.org/#/markdown-mode
5 [melpa-badge]: https://melpa.org/packages/markdown-mode-badge.svg
6 [melpa-stable-badge]: https://stable.melpa.org/packages/markdown-mode-badge.svg
7 [github-actions-link]: https://github.com/jrblevin/markdown-mode/actions
8 [github-actions-badge]: https://github.com/jrblevin/markdown-mode/workflows/CI/badge.svg
9 [leanpub-link]: https://leanpub.com/markdown-mode
10 [leanpub-badge]: https://img.shields.io/badge/leanpub-guide-orange.svg
12 markdown-mode is a major mode for editing [Markdown][]-formatted
13 text. The latest stable version is markdown-mode 2.4, released on
14 May 30, 2020. See the [release notes][] for details.
15 markdown-mode is free software, licensed under the GNU GPL,
18 ![Markdown Mode Screenshot](https://jblevins.org/projects/markdown-mode/screenshots/20170818-001.png)
20 [Markdown]: http://daringfireball.net/projects/markdown/
21 [release notes]: https://github.com/jrblevin/markdown-mode/releases/tag/v2.4
25 <a href="https://leanpub.com/markdown-mode">
26 <img src="https://jblevins.org/projects/markdown-mode/guide-v2.3.png" align="right" height="350" width="231">
29 The primary documentation for Markdown Mode is available below, and
30 is generated from comments in the source code. For a more in-depth
31 treatment, the [_Guide to Markdown Mode for Emacs_][guide] covers
32 Markdown syntax, advanced movement and editing in Emacs,
33 extensions, configuration examples, tips and tricks, and a survey
34 of other packages that work with Markdown Mode. Finally, Emacs is
35 also a self-documenting editor. This means that the source code
36 itself contains additional documentation: each function has its own
37 docstring available via <kbd>C-h f</kbd> (`describe-function`), individual
38 keybindings can be investigated with <kbd>C-h k</kbd> (`describe-key`), and
39 a complete list of keybindings is available using <kbd>C-h m</kbd>
42 [guide]: https://leanpub.com/markdown-mode
46 _Note:_ To use all of the features of `markdown-mode`, you'll need
47 to install the Emacs package itself and also have a local Markdown
48 processor installed (e.g., Markdown.pl, MultiMarkdown, or Pandoc).
49 The external processor is not required for editing, but will be
50 used for rendering HTML for preview and export. After installing
51 the Emacs package, be sure to configure `markdown-command` to point
52 to the preferred Markdown executable on your system. See the
53 Customization section below for more details.
55 The recommended way to install `markdown-mode` is to install the package
56 from [MELPA Stable](https://stable.melpa.org/#/markdown-mode)
57 using `package.el`. First, configure `package.el` and the MELPA Stable
58 repository by adding the following to your `.emacs`, `init.el`,
59 or equivalent startup file:
63 (add-to-list 'package-archives
64 '("melpa-stable" . "https://stable.melpa.org/packages/"))
68 Then, after restarting Emacs or evaluating the above statements, issue
69 the following command: <kbd>M-x package-install RET markdown-mode RET</kbd>.
70 When installed this way, the major modes `markdown-mode` and `gfm-mode`
71 will be autoloaded and `markdown-mode` will be used for file names
72 ending in `.md`, `.markdown`, `.mkd`, `.mdown`, `.mkdn`, `.mdwn`.
74 Alternatively, if you manage loading packages with [use-package][]
75 then you can automatically install and configure `markdown-mode` by
76 adding a declaration such as this one to your init file (as an
77 example; adjust settings as desired):
80 (use-package markdown-mode
82 :mode ("README\\.md\\'" . gfm-mode)
83 :init (setq markdown-command "multimarkdown"))
86 [MELPA Stable]: http://stable.melpa.org/
87 [use-package]: https://github.com/jwiegley/use-package
91 Alternatively you can manually download and install markdown-mode.
92 First, download the [latest stable version][markdown-mode.el] and
93 save the file where Emacs can find it (i.e., a directory in your
94 `load-path`). You can then configure `markdown-mode` and `gfm-mode`
95 to load automatically by adding the following to your init file:
98 (autoload 'markdown-mode "markdown-mode"
99 "Major mode for editing Markdown files" t)
100 (add-to-list 'auto-mode-alist
101 '("\\.\\(?:md\\|markdown\\|mkd\\|mdown\\|mkdn\\|mdwn\\)\\'" . markdown-mode))
103 (autoload 'gfm-mode "markdown-mode"
104 "Major mode for editing GitHub Flavored Markdown files" t)
105 (add-to-list 'auto-mode-alist '("README\\.md\\'" . gfm-mode))
108 [markdown-mode.el]: https://jblevins.org/projects/markdown-mode/markdown-mode.el
110 **Development Version**
112 To follow or contribute to markdown-mode development, you can
113 browse or clone the Git repository
114 [on GitHub](https://github.com/jrblevin/markdown-mode):
117 git clone https://github.com/jrblevin/markdown-mode.git
120 If you prefer to install and use the development version, which may
121 become unstable at some times, you can either clone the Git
122 repository as above or install markdown-mode from
123 [MELPA](https://melpa.org/#/markdown-mode).
125 If you clone the repository directly, then make sure that Emacs can
126 find it by adding the following line to your startup file:
129 (add-to-list 'load-path "/path/to/markdown-mode/repository")
132 **Packaged Installation**
134 markdown-mode is also available in several package managers. You
135 may want to confirm that the package you install contains the
136 latest stable version first (and please notify the package
139 * Debian Linux: [elpa-markdown-mode][] and [emacs-goodies-el][]
140 * Ubuntu Linux: [elpa-markdown-mode][elpa-ubuntu] and [emacs-goodies-el][emacs-goodies-el-ubuntu]
141 * RedHat and Fedora Linux: [emacs-goodies][]
142 * NetBSD: [textproc/markdown-mode][]
143 * MacPorts: [markdown-mode.el][macports-package] ([pending][macports-ticket])
144 * FreeBSD: [textproc/markdown-mode.el][freebsd-port]
146 [elpa-markdown-mode]: https://packages.debian.org/sid/lisp/elpa-markdown-mode
147 [elpa-ubuntu]: http://packages.ubuntu.com/search?keywords=elpa-markdown-mode
148 [emacs-goodies-el]: http://packages.debian.org/emacs-goodies-el
149 [emacs-goodies-el-ubuntu]: http://packages.ubuntu.com/search?keywords=emacs-goodies-el
150 [emacs-goodies]: https://apps.fedoraproject.org/packages/emacs-goodies
151 [textproc/markdown-mode]: http://pkgsrc.se/textproc/markdown-mode
152 [macports-package]: https://trac.macports.org/browser/trunk/dports/editors/markdown-mode.el/Portfile
153 [macports-ticket]: http://trac.macports.org/ticket/35716
154 [freebsd-port]: http://svnweb.freebsd.org/ports/head/textproc/markdown-mode.el
158 To enable editing of code blocks in indirect buffers using <kbd>C-c '</kbd>,
159 you will need to install the [`edit-indirect`][ei] package.
161 [ei]: https://github.com/Fanael/edit-indirect/
165 Keybindings are grouped by prefixes based on their function. For
166 example, the commands for styling text are grouped under <kbd>C-c C-s</kbd>
167 and toggle commands begin with <kbd>C-c C-x</kbd>. The primary commands in
168 each group will are described below. You can obtain a list of all
169 keybindings by pressing <kbd>C-c C-h</kbd>. Movement and shifting commands
170 tend to be associated with paired delimiters such as <kbd>M-{</kbd> and
171 <kbd>M-}</kbd> or <kbd>C-c <</kbd> and <kbd>C-c ></kbd>. Outline navigation keybindings the
172 same as in `org-mode`. Finally, commands for running Markdown or
173 doing maintenance on an open file are grouped under the <kbd>C-c C-c</kbd>
174 prefix. The most commonly used commands are described below. You
175 can obtain a list of all keybindings by pressing <kbd>C-c C-h</kbd>.
177 * Links and Images: <kbd>C-c C-l</kbd> and <kbd>C-c C-i</kbd>
179 <kbd>C-c C-l</kbd> (`markdown-insert-link`) is a general command for
180 inserting new link markup or editing existing link markup. This
181 is especially useful when markup or URL hiding is enabled, so
182 that URLs can't easily be edited directly. This command can be
183 used to insert links of any form: either inline links,
184 reference links, or plain URLs in angle brackets. The URL or
185 `[reference]` label, link text, and optional title are entered
186 through a series of interactive prompts. The type of link is
187 determined by which values are provided:
189 * If both a URL and link text are given, insert an inline link:
191 * If both a `[reference]` label and link text are given, insert
192 a reference link: `[text][reference]`.
193 * If only link text is given, insert an implicit reference link:
195 * If only a URL is given, insert a plain URL link:
198 Similarly, <kbd>C-c C-i</kbd> (`markdown-insert-image`) is a general
199 command for inserting or editing image markup. As with the link
200 insertion command, through a series interactive prompts you can
201 insert either an inline or reference image:
203 * If both a URL and alt text are given, insert an inline
204 image: `![alt text](url)`.
205 * If both a `[reference]` label and alt text are given,
206 insert a reference link: `![alt text][reference]`.
208 If there is an existing link or image at the point, these
209 command will edit the existing markup rather than inserting new
210 markup. Otherwise, if there is an active region, these commands
211 use the region as either the default URL (if it seems to be a
212 URL) or link text value otherwise. In that case, the region
213 will be deleted and replaced by the link.
215 Note that these functions can be used to convert links and
216 images from one type to another (inline, reference, or plain
217 URL) by selectively adding or removing properties via the
220 If a reference label is given that is not yet defined, you
221 will be prompted for the URL and optional title and the
222 reference will be inserted according to the value of
223 `markdown-reference-location`. If a title is given, it will be
224 added to the end of the reference definition and will be used
225 to populate the title attribute when converted to HTML. In addition, it is
226 possible to have the `markdown-link-make-text-function` function, if
227 non-nil, define the default link text before prompting the user for it.
229 If `markdown-disable-tooltip-prompt` is non-nil, the user will not be
230 prompted to add or modify a tooltip text.
232 Images associated with image links may be displayed
233 inline in the buffer by pressing <kbd>C-c C-x C-i</kbd>
234 (`markdown-toggle-inline-images`). This is a toggle command, so
235 pressing this once again will remove inline images.
236 By default, only local images are displayed. However, remote
237 images will also be downloaded and displayed if
238 `markdown-display-remote-images` is non-nil.
240 Large images may be scaled down to fit in the buffer using
241 `markdown-max-image-size`, a cons cell of the form `(max-width
242 . max-height)`. Resizing requires Emacs to be built with
245 * Text Styles: <kbd>C-c C-s</kbd>
247 <kbd>C-c C-s i</kbd> inserts markup to make a region or word italic. If
248 there is an active region, make the region italic. If the point
249 is at a non-italic word, make the word italic. If the point is
250 at an italic word or phrase, remove the italic markup.
251 Otherwise, simply insert italic delimiters and place the point
252 in between them. Similarly, use <kbd>C-c C-s b</kbd> for bold, <kbd>C-c C-s c</kbd>
253 for inline code, and <kbd>C-c C-s k</kbd> for inserting `<kbd>` tags.
255 <kbd>C-c C-s q</kbd> inserts a blockquote using the active region, if
256 any, or starts a new blockquote. <kbd>C-c C-s Q</kbd> is a variation
257 which always operates on the region, regardless of whether it
258 is active or not (i.e., when `transient-mark-mode` is off but
259 the mark is set). The appropriate amount of indentation, if
260 any, is calculated automatically given the surrounding context,
261 but may be adjusted later using the region indentation
264 <kbd>C-c C-s p</kbd> behaves similarly for inserting preformatted code
265 blocks (with <kbd>C-c C-s P</kbd> being the region-only counterpart)
266 and <kbd>C-c C-s C</kbd> inserts a GFM style backquote fenced code block.
268 * Headings: <kbd>C-c C-s</kbd>
270 To insert or replace headings, there are two options. You can
271 insert a specific level heading directly or you can have
272 `markdown-mode` determine the level for you based on the previous
273 heading. As with the other markup commands, the heading
274 insertion commands use the text in the active region, if any,
275 as the heading text. Otherwise, if the current line is not
276 blank, they use the text on the current line. Finally, the
277 setext commands will prompt for heading text if there is no
278 active region and the current line is blank.
280 <kbd>C-c C-s h</kbd> inserts a heading with automatically chosen type and
281 level (both determined by the previous heading). <kbd>C-c C-s H</kbd>
282 behaves similarly, but uses setext (underlined) headings when
283 possible, still calculating the level automatically.
284 In cases where the automatically-determined level is not what
285 you intended, the level can be quickly promoted or demoted
286 (as described below). Alternatively, a <kbd>C-u</kbd> prefix can be
287 given to insert a heading _promoted_ (lower number) by one
288 level or a <kbd>C-u C-u</kbd> prefix can be given to insert a heading
289 demoted (higher number) by one level.
291 To insert a heading of a specific level and type, use <kbd>C-c C-s 1</kbd>
292 through <kbd>C-c C-s 6</kbd> for atx (hash mark) headings and <kbd>C-c C-s !</kbd> or
293 <kbd>C-c C-s @</kbd> for setext headings of level one or two, respectively.
294 Note that <kbd>!</kbd> is <kbd>S-1</kbd> and <kbd>@</kbd> is <kbd>S-2</kbd>.
296 If the point is at a heading, these commands will replace the
297 existing markup in order to update the level and/or type of the
298 heading. To remove the markup of the heading at the point,
299 press <kbd>C-c C-k</kbd> to kill the heading and press <kbd>C-y</kbd> to yank the
300 heading text back into the buffer.
302 * Horizontal Rules: <kbd>C-c C-s -</kbd>
304 <kbd>C-c C-s -</kbd> inserts a horizontal rule. By default, insert the
305 first string in the list `markdown-hr-strings` (the most
306 prominent rule). With a <kbd>C-u</kbd> prefix, insert the last string.
307 With a numeric prefix <kbd>N</kbd>, insert the string in position <kbd>N</kbd>
310 * Footnotes: <kbd>C-c C-s f</kbd>
312 <kbd>C-c C-s f</kbd> inserts a footnote marker at the point, inserts a
313 footnote definition below, and positions the point for
314 inserting the footnote text. Note that footnotes are an
315 extension to Markdown and are not supported by all processors.
317 * Wiki Links: <kbd>C-c C-s w</kbd>
319 <kbd>C-c C-s w</kbd> inserts a wiki link of the form `[[WikiLink]]`. If
320 there is an active region, use the region as the link text. If the
321 point is at a word, use the word as the link text. If there is
322 no active region and the point is not at word, simply insert
323 link markup. Note that wiki links are an extension to Markdown
324 and are not supported by all processors.
326 * Markdown and Maintenance Commands: <kbd>C-c C-c</kbd>
328 *Compile:* <kbd>C-c C-c m</kbd> will run Markdown on the current buffer
329 and show the output in another buffer. *Preview*: <kbd>C-c C-c p</kbd>
330 runs Markdown on the current buffer and previews, stores the
331 output in a temporary file, and displays the file in a browser.
332 *Export:* <kbd>C-c C-c e</kbd> will run Markdown on the current buffer
333 and save the result in the file `basename.html`, where
334 `basename` is the name of the Markdown file with the extension
335 removed. *Export and View:* press <kbd>C-c C-c v</kbd> to export the
336 file and view it in a browser. *Open:* <kbd>C-c C-c o</kbd> will open
337 the Markdown source file directly using `markdown-open-command`.
338 *Live Export*: Press <kbd>C-c C-c l</kbd> to turn on
339 `markdown-live-preview-mode` to view the exported output
340 side-by-side with the source Markdown. **For all export commands,
341 the output file will be overwritten without notice.**
342 `markdown-live-preview-window-function` can be customized to open
343 in a browser other than `eww`. If you want to force the
344 preview window to appear at the bottom or right, you can
345 customize `markdown-split-window-direction`.
349 - <kbd>C-c C-c m</kbd>: `markdown-command` > `*markdown-output*` buffer.
350 - <kbd>C-c C-c p</kbd>: `markdown-command` > temporary file > browser.
351 - <kbd>C-c C-c e</kbd>: `markdown-command` > `basename.html`.
352 - <kbd>C-c C-c v</kbd>: `markdown-command` > `basename.html` > browser.
353 - <kbd>C-c C-c w</kbd>: `markdown-command` > kill ring.
354 - <kbd>C-c C-c o</kbd>: `markdown-open-command`.
355 - <kbd>C-c C-c l</kbd>: `markdown-live-preview-mode` > `*eww*` buffer.
357 <kbd>C-c C-c c</kbd> will check for undefined references. If there are
358 any, a small buffer will open with a list of undefined
359 references and the line numbers on which they appear. In Emacs
360 22 and greater, selecting a reference from this list and
361 pressing <kbd>RET</kbd> will insert an empty reference definition at the
362 end of the buffer. Similarly, selecting the line number will
363 jump to the corresponding line.
365 <kbd>C-c C-c u</kbd> will check for unused references. This will
366 also open a small buffer if any are found, similar to undefined
367 reference checking. The buffer for unused references will contain
368 `X` buttons that remove unused references when selected.
370 <kbd>C-c C-c n</kbd> renumbers any ordered lists in the buffer that are
373 <kbd>C-c C-c ]</kbd> completes all headings and normalizes all horizontal
376 * Following Links: <kbd>C-c C-o</kbd>
378 Press <kbd>C-c C-o</kbd> when the point is on an inline or reference
379 link to open the URL in a browser. When the point is at a
380 wiki link, open it in another buffer (in the current window,
381 or in the other window with the <kbd>C-u</kbd> prefix). Use <kbd>M-p</kbd> and
382 <kbd>M-n</kbd> to quickly jump to the previous or next link of any type.
384 * Doing Things: <kbd>C-c C-d</kbd>
386 Use <kbd>C-c C-d</kbd> to do something sensible with the object at the point:
388 - Jumps between reference links and reference definitions.
389 If more than one link uses the same reference label, a
390 window will be shown containing clickable buttons for
391 jumping to each link. Pressing <kbd>TAB</kbd> or <kbd>S-TAB</kbd> cycles
392 between buttons in this window.
393 - Jumps between footnote markers and footnote text.
394 - Toggles the completion status of GFM task list items
396 - Re-aligns table columns.
398 * Promotion and Demotion: <kbd>C-c C--</kbd> and <kbd>C-c C-=</kbd>
400 Headings, horizontal rules, and list items can be promoted and
401 demoted, as well as bold and italic text. For headings,
402 "promotion" means *decreasing* the level (i.e., moving from
403 `<h2>` to `<h1>`) while "demotion" means *increasing* the
404 level. For horizontal rules, promotion and demotion means
405 moving backward or forward through the list of rule strings in
406 `markdown-hr-strings`. For bold and italic text, promotion and
407 demotion means changing the markup from underscores to asterisks.
408 Press <kbd>C-c C--</kbd> or <kbd>C-c LEFT</kbd> to promote the element at the point
411 To remember these commands, note that <kbd>-</kbd> is for decreasing the
412 level (promoting), and <kbd>=</kbd> (on the same key as <kbd>+</kbd>) is for
413 increasing the level (demoting). Similarly, the left and right
414 arrow keys indicate the direction that the atx heading markup
415 is moving in when promoting or demoting.
417 * Completion: <kbd>C-c C-]</kbd>
419 Complete markup is in normalized form, which means, for
420 example, that the underline portion of a setext header is the
421 same length as the heading text, or that the number of leading
422 and trailing hash marks of an atx header are equal and that
423 there is no extra whitespace in the header text. <kbd>C-c C-]</kbd>
424 completes the markup at the point, if it is determined to be
427 * Editing Lists: <kbd>M-RET</kbd>, <kbd>C-c UP</kbd>, <kbd>C-c DOWN</kbd>, <kbd>C-c LEFT</kbd>, and <kbd>C-c RIGHT</kbd>
429 New list items can be inserted with <kbd>M-RET</kbd> or <kbd>C-c C-j</kbd>. This
430 command determines the appropriate marker (one of the possible
431 unordered list markers or the next number in sequence for an
432 ordered list) and indentation level by examining nearby list
433 items. If there is no list before or after the point, start a
434 new list. As with heading insertion, you may prefix this
435 command by <kbd>C-u</kbd> to decrease the indentation by one level.
436 Prefix this command by <kbd>C-u C-u</kbd> to increase the indentation by
439 Existing list items (and their nested sub-items) can be moved
440 up or down with <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> and indented or
441 outdented with <kbd>C-c RIGHT</kbd> or <kbd>C-c LEFT</kbd>.
443 * Editing Subtrees: <kbd>C-c UP</kbd>, <kbd>C-c DOWN</kbd>, <kbd>C-c LEFT</kbd>, and <kbd>C-c RIGHT</kbd>
445 Entire subtrees of ATX headings can be promoted and demoted
446 with <kbd>C-c LEFT</kbd> and <kbd>C-c RIGHT</kbd>, which are the same keybindings
447 used for promotion and demotion of list items. If the point is in
448 a list item, the operate on the list item. Otherwise, they operate
449 on the current heading subtree. Similarly, subtrees can be
450 moved up and down with <kbd>C-c UP</kbd> and <kbd>C-c DOWN</kbd>.
452 These commands currently do not work properly if there are
453 Setext headings in the affected region.
455 Please note the following "boundary" behavior for promotion and
456 demotion. Any level-six headings will not be demoted further
457 (i.e., they remain at level six, since Markdown and HTML define
458 only six levels) and any level-one headings will promoted away
459 entirely (i.e., heading markup will be removed, since a
460 level-zero heading is not defined).
462 * Shifting the Region: <kbd>C-c <</kbd> and <kbd>C-c ></kbd>
464 Text in the region can be indented or outdented as a group using
465 <kbd>C-c ></kbd> to indent to the next indentation point (calculated in
466 the current context), and <kbd>C-c <</kbd> to outdent to the previous
467 indentation point. These keybindings are the same as those for
468 similar commands in `python-mode`.
470 * Killing Elements: <kbd>C-c C-k</kbd>
472 Press <kbd>C-c C-k</kbd> to kill the thing at point and add important
473 text, without markup, to the kill ring. Possible things to
474 kill include (roughly in order of precedece): inline code,
475 headings, horizontal rules, links (add link text to kill ring),
476 images (add alt text to kill ring), angle URIs, email
477 addresses, bold, italics, reference definitions (add URI to
478 kill ring), footnote markers and text (kill both marker and
479 text, add text to kill ring), and list items.
481 * Outline Navigation: <kbd>C-c C-n</kbd>, <kbd>C-c C-p</kbd>, <kbd>C-c C-f</kbd>, <kbd>C-c C-b</kbd>, and <kbd>C-c C-u</kbd>
483 These keys are used for hierarchical navigation in lists and
484 headings. When the point is in a list, they move between list
485 items. Otherwise, they move between headings. Use <kbd>C-c C-n</kbd> and
486 <kbd>C-c C-p</kbd> to move between the next and previous visible
487 headings or list items of any level. Similarly, <kbd>C-c C-f</kbd> and
488 <kbd>C-c C-b</kbd> move to the next and previous visible headings or
489 list items at the same level as the one at the point. Finally,
490 <kbd>C-c C-u</kbd> will move up to the parent heading or list item.
492 * Movement by Markdown paragraph: <kbd>M-{</kbd>, <kbd>M-}</kbd>, and <kbd>M-h</kbd>
494 Paragraphs in `markdown-mode` are regular paragraphs,
495 paragraphs inside blockquotes, individual list items, headings,
496 etc. These keys are usually bound to `forward-paragraph` and
497 `backward-paragraph`, but the built-in Emacs functions are
498 based on simple regular expressions that fail in Markdown
499 files. Instead, they are bound to `markdown-forward-paragraph`
500 and `markdown-backward-paragraph`. To mark a paragraph,
501 you can use <kbd>M-h</kbd> (`markdown-mark-paragraph`).
503 * Movement by Markdown block: <kbd>C-M-{</kbd>, <kbd>C-M-}</kbd>, and <kbd>C-c M-h</kbd>
505 Markdown blocks are regular paragraphs in many cases, but
506 contain many paragraphs in other cases: blocks are considered
507 to be entire lists, entire code blocks, and entire blockquotes.
508 To move backward one block use <kbd>C-M-{</kbd>
509 (`markdown-beginning-block`) and to move forward use <kbd>C-M-}</kbd>
510 (`markdown-end-of-block`). To mark a block, use <kbd>C-c M-h</kbd>
511 (`markdown-mark-block`).
513 * Movement by Defuns: <kbd>C-M-a</kbd>, <kbd>C-M-e</kbd>, and <kbd>C-M-h</kbd>
515 The usual Emacs commands can be used to move by defuns
516 (top-level major definitions). In markdown-mode, a defun is a
517 section. As usual, <kbd>C-M-a</kbd> will move the point to the
518 beginning of the current or preceding defun, <kbd>C-M-e</kbd> will move
519 to the end of the current or following defun, and <kbd>C-M-h</kbd> will
520 put the region around the entire defun.
524 Markdown Mode includes support for editing tables, which
525 have the following basic format:
527 | Right | Left | Center | Default |
528 |------:|:-----|:------:|---------|
529 | 12 | 12 | 12 | 12 |
530 | 123 | 123 | 123 | 123 |
533 The first line contains column headers. The second line
534 contains a separator line between the headers and the content.
535 Each following line is a row in the table. Columns are always
536 separated by the pipe character. The colons indicate column
539 A table is re-aligned automatically each time you press <kbd>TAB</kbd>
540 or <kbd>RET</kbd> inside the table. <kbd>TAB</kbd> also moves to the next
541 field (<kbd>RET</kbd> to the next row) and creates new table rows at
542 the end of the table or before horizontal separator lines. The
543 indentation of the table is set by the first line. Column
544 centering inside Emacs is not supported.
546 Beginning pipe characters are required for proper detection of
547 table borders inside Emacs. Any line starting with `|-` or `|:`
548 is considered as a horizontal separator line and will be
549 expanded on the next re-align to span the whole table width. No
550 padding is allowed between the beginning pipe character and
551 header separator symbol. So, to create the above table, you
554 |Right|Left|Center|Default|
557 and then press <kbd>TAB</kbd> to align the table and start filling in
560 Then you can jump with <kbd>TAB</kbd> from one cell to the next or with
561 <kbd>S-TAB</kbd> to the previous one. <kbd>RET</kbd> will jump to the to the
562 next cell in the same column, and create a new row if there is
563 no such cell or if the next row is beyond a separator line.
565 You can also convert selected region to a table. Basic editing
566 capabilities include inserting, deleting, and moving of columns
567 and rows, and table re-alignment, sorting, transposition:
569 - <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> - Move the current row up or down.
570 - <kbd>C-c LEFT</kbd> or <kbd>C-c RIGHT</kbd> - Move the current column left or right.
571 - <kbd>C-c S-UP</kbd> - Kill the current row.
572 - <kbd>C-c S-DOWN</kbd> - Insert a row above the current row. With a
573 prefix argument, row line is created below the current one.
574 - <kbd>C-c S-LEFT</kbd> - Kill the current column.
575 - <kbd>C-c S-RIGHT</kbd> - Insert a new column to the left of the current one.
576 - <kbd>C-c C-d</kbd> - Re-align the current table (`markdown-do`).
577 - <kbd>C-c C-c ^</kbd> - Sort the rows of a table by a specified column.
578 This command prompts you for the column number and a sort
579 method (alphabetical or numerical, optionally in reverse).
580 - <kbd>C-c C-c |</kbd> - Convert the region to a table. This function
581 attempts to recognize comma, tab, and space separated data
582 and then splits the data into cells accordingly.
583 - <kbd>C-c C-c t</kbd> - Transpose table at point.
585 The table editing functions try to handle markup hiding
586 correctly when calculating column widths, however, columns
587 containing hidden markup may not always be aligned properly.
589 <kbd>C-c C-s t</kbd> (`markdown-insert-table`) is a general command for inserting new table.
590 The command prompts for table size and column alignment and inserts an empty pipe table at point.
594 Read-only viewing modes, `markdown-view-mode` and `gfm-view-mode`
595 are provided for viewing Markdown content. These modes provide
596 simplified keybindings for navigating the buffer. Many of these
597 are like `help-mode` and `view-mode`, such as <kbd>SPC</kbd>,
598 <kbd>DEL</kbd>, <kbd><</kbd>, and <kbd>></kbd> for scrolling,
599 <kbd>q</kbd> for quitting, and <kbd>?</kbd> or <kbd>h</kbd> for
600 help. Other keys are provided that mirror the outline navigation
601 commands when editing: <kbd>n</kbd>, <kbd>p</kbd>, <kbd>f</kbd>,
602 <kbd>b</kbd>, and <kbd>u</kbd>. Both of these modes enable markup
603 hiding by default, but this can be customized by setting
604 `markdown-hide-markup-in-view-modes`.
606 * Miscellaneous Commands:
608 When the [`edit-indirect`][ei] package is installed, <kbd>C-c '</kbd>
609 (`markdown-edit-code-block`) can be used to edit a code block
610 in an indirect buffer in the native major mode. Press <kbd>C-c C-c</kbd>
611 to commit changes and return or <kbd>C-c C-k</kbd> to cancel. You can
612 also give a prefix argument to the insertion command, as in
613 <kbd>C-u C-c C-s C</kbd>, to edit the code block in an indirect buffer
616 As noted, many of the commands above behave differently depending
617 on whether Transient Mark mode is enabled or not. When it makes
618 sense, if Transient Mark mode is on and the region is active, the
619 command applies to the text in the region (e.g., <kbd>C-c C-s b</kbd> makes the
620 region bold). For users who prefer to work outside of Transient
621 Mark mode, since Emacs 22 it can be enabled temporarily by pressing
622 <kbd>C-SPC C-SPC</kbd>. When this is not the case, many commands then
623 proceed to look work with the word or line at the point.
625 When applicable, commands that specifically act on the region even
626 outside of Transient Mark mode have the same keybinding as their
627 standard counterpart, but the letter is uppercase. For example,
628 `markdown-insert-blockquote` is bound to <kbd>C-c C-s q</kbd> and only acts on
629 the region in Transient Mark mode while `markdown-blockquote-region`
630 is bound to <kbd>C-c C-s Q</kbd> and always applies to the region (when nonempty).
632 Note that these region-specific functions are useful in many
633 cases where it may not be obvious. For example, yanking text from
634 the kill ring sets the mark at the beginning of the yanked text
635 and moves the point to the end. Therefore, the (inactive) region
636 contains the yanked text. So, <kbd>C-y</kbd> followed by <kbd>C-c C-s Q</kbd> will
637 yank text and turn it into a blockquote.
639 markdown-mode attempts to be flexible in how it handles
640 indentation. When you press <kbd>TAB</kbd> repeatedly, the point will cycle
641 through several possible indentation levels corresponding to things
642 you might have in mind when you press <kbd>RET</kbd> at the end of a line or
643 <kbd>TAB</kbd>. For example, you may want to start a new list item,
644 continue a list item with hanging indentation, indent for a nested
645 pre block, and so on. Outdenting is handled similarly when backspace
646 is pressed at the beginning of the non-whitespace portion of a line.
648 markdown-mode supports outline-minor-mode as well as org-mode-style
649 visibility cycling for atx- or hash-style headings. There are two
650 types of visibility cycling: Pressing <kbd>S-TAB</kbd> cycles globally between
651 the table of contents view (headings only), outline view (top-level
652 headings only), and the full document view. Pressing <kbd>TAB</kbd> while the
653 point is at a heading will cycle through levels of visibility for the
654 subtree: completely folded, visible children, and fully visible.
655 Note that mixing hash and underline style headings will give undesired
660 Although no configuration is *necessary* there are a few things
661 that can be customized. The <kbd>M-x customize-mode</kbd> command
662 provides an interface to all of the possible customizations:
664 * `markdown-command` - the command used to run Markdown (default:
665 `markdown`). This variable may be customized to pass
666 command-line options to your Markdown processor of choice. We recommend
667 you to use list of strings if you want to set command line options like.
668 `'("pandoc" "--from=markdown" "--to=html5")`. It can also be a
669 function; in this case `markdown` will call it with three
670 arguments: the beginning and end of the region to process, and
671 a buffer to write the output to.
673 * `markdown-command-needs-filename` - set to `t` if
674 `markdown-command` does not accept standard input (default:
675 `nil`). When `nil`, `markdown-mode` will pass the Markdown
676 content to `markdown-command` using standard input (`stdin`).
677 When set to `t`, `markdown-mode` will pass the name of the file
678 as the final command-line argument to `markdown-command`. Note
679 that in the latter case, you will only be able to run
680 `markdown-command` from buffers which are visiting a file. If
681 `markdown-command` is a function, `markdown-command-needs-filename`
684 * `markdown-open-command` - the command used for calling a standalone
685 Markdown previewer which is capable of opening Markdown source files
686 directly (default: `nil`). This command will be called
687 with a single argument, the filename of the current buffer.
688 A representative program is the Mac app [Marked 2][], a
689 live-updating Markdown previewer which can be [called from a
690 simple shell script](https://jblevins.org/log/marked-2-command).
691 This variable can also be a function; in this case `markdown-open`
692 will call it without arguments to preview the current buffer.
694 * `markdown-open-image-command` - the command used for opening image
695 link (default: `nil`) via `markdown-follow-*` commands. This variable
696 can also be a function, in this case it is called with a single argument,
697 image-link. If this value is `nil`, `markdown-mode` opens image links
700 * `markdown-hr-strings` - list of strings to use when inserting
701 horizontal rules. Different strings will not be distinguished
702 when converted to HTML--they will all be converted to
703 `<hr/>`--but they may add visual distinction and style to plain
704 text documents. To maintain some notion of promotion and
705 demotion, keep these sorted from largest to smallest.
707 * `markdown-bold-underscore` - set to a non-nil value to use two
708 underscores when inserting bold text instead of two asterisks
711 * `markdown-italic-underscore` - set to a non-nil value to use
712 underscores when inserting italic text instead of asterisks
715 * `markdown-asymmetric-header` - set to a non-nil value to use
716 asymmetric header styling, placing header characters only on
717 the left of headers (default: `nil`).
719 * `markdown-header-scaling` - set to a non-nil value to use
720 a variable-pitch font for headings where the size corresponds
721 to the level of the heading (default: `nil`).
723 * `markdown-header-scaling-values` - list of scaling values,
724 relative to baseline, for headers of levels one through six,
725 used when `markdown-header-scaling` is non-nil
726 (default: `(2.0 1.7 1.4 1.1 1.0 1.0)`).
728 * `markdown-marginalize-headers` - put opening atx header markup
729 in the left margin when non-nil (default: `nil`).
731 * `markdown-marginalize-headers-margin-width` - width of margin
732 used for marginalized headers (default: 6).
734 * `markdown-list-indent-width` - depth of indentation for lists
735 when inserting, promoting, and demoting list items (default: 4).
737 * `markdown-indent-function` - the function to use for automatic
738 indentation (default: `markdown-indent-line`).
740 * `markdown-indent-on-enter` - Set to a non-nil value to
741 automatically indent new lines when <kbd>RET</kbd> is pressed.
742 Set to `indent-and-new-item` to additionally continue lists
743 when <kbd>RET</kbd> is pressed (default: `t`).
745 * `markdown-enable-wiki-links` - syntax highlighting for wiki
746 links (default: `nil`). Set this to a non-nil value to turn on
747 wiki link support by default. Wiki link support can be toggled
748 later using the function `markdown-toggle-wiki-links`."
750 * `markdown-wiki-link-alias-first` - set to a non-nil value to
751 treat aliased wiki links like `[[link text|PageName]]`
752 (default: `t`). When set to nil, they will be treated as
753 `[[PageName|link text]]`.
755 * `markdown-uri-types` - a list of protocol schemes (e.g., "http")
756 for URIs that `markdown-mode` should highlight.
758 * `markdown-enable-math` - font lock for inline and display LaTeX
759 math expressions (default: `nil`). Set this to `t` to turn on
760 math support by default. Math support can be toggled
761 interactively later using <kbd>C-c C-x C-e</kbd>
762 (`markdown-toggle-math`).
764 * `markdown-enable-html` - font lock for HTML tags and attributes
767 * `markdown-css-paths` - CSS files to link to in XHTML output
768 (default: `nil`). These can be either local files (relative or
771 * `markdown-content-type` - used to set to the `http-equiv`
772 attribute to be included in the XHTML `<head>` block (default:
773 `"text/html"`). Set to an alternate value `application/xhtml+xml`
774 if needed, or set to an empty string to remove the attribute. See
775 also: `markdown-coding-system`.
777 * `markdown-coding-system` - used for specifying the character
778 set identifier in the `http-equiv` attribute when included
779 (default: `nil`). See `markdown-content-type`, which must
780 be set for this variable to have any effect. When set to `nil`,
781 `buffer-file-coding-system` will be used to automatically
782 determine the coding system string (falling back to
783 `utf-8` when unavailable). Common settings are `iso-8859-1`
786 * `markdown-xhtml-header-content` - additional content to include
787 in the XHTML `<head>` block (default: `""`).
789 * `markdown-xhtml-body-preamble` - additional content to include in
790 the XHTML <body> block, before the output (default: `""`). This
791 is useful for enclosing additional elements around the Markdown
794 * `markdown-xhtml-body-epilogue` - additional content to include in
795 the XHTML <body> block, after the output (default: `""`). This is
796 useful for enclosing additional elements around the Markdown
799 * `markdown-xhtml-standalone-regexp` - a regular expression which
800 `markdown-mode` uses to determine whether the output of
801 `markdown-command` is a standalone XHTML document or an XHTML
802 fragment (default: `"^\\(<\\?xml\\|<!DOCTYPE\\|<html\\)"`). If
803 this regular expression not matched in the first five lines of
804 output, `markdown-mode` assumes the output is a fragment and
805 adds a header and footer.
807 * `markdown-link-space-sub-char` - a character to replace spaces
808 when mapping wiki links to filenames (default: `"_"`).
809 For example, use an underscore for compatibility with the
810 Python Markdown WikiLinks extension. In `gfm-mode`, this is
811 set to `"-"` to conform with GitHub wiki links.
813 * `markdown-reference-location` - where to insert reference
814 definitions (default: `header`). The possible locations are
815 the end of the document (`end`), after the current block
816 (`immediately`), the end of the current subtree (`subtree`),
817 or before the next header (`header`).
819 * `markdown-footnote-location` - where to insert footnote text
820 (default: `end`). The set of location options is the same as
821 for `markdown-reference-location`.
823 * `markdown-nested-imenu-heading-index` - Use nested imenu
824 heading instead of a flat index (default: `t`). A nested
825 index may provide more natural browsing from the menu, but a
826 flat list may allow for faster keyboard navigation via tab
829 * `markdown-add-footnotes-to-imenu` - Add footnote definitions to
830 the end of the imenu index (default: `t`).
832 * `comment-auto-fill-only-comments` - variable is made
833 buffer-local and set to `nil` by default. In programming
834 language modes, when this variable is non-nil, only comments
835 will be filled by auto-fill-mode. However, comments in
836 Markdown documents are rare and the most users probably intend
837 for the actual content of the document to be filled. Making
838 this variable buffer-local allows `markdown-mode` to override
839 the default behavior induced when the global variable is non-nil.
841 * `markdown-gfm-additional-languages`, - additional languages to
842 make available, aside from those predefined in
843 `markdown-gfm-recognized-languages`, when inserting GFM code
844 blocks (default: `nil`). Language strings must have be trimmed
845 of whitespace and not contain any curly braces. They may be of
846 arbitrary capitalization, though.
848 * `markdown-gfm-use-electric-backquote` - use
849 `markdown-electric-backquote` for interactive insertion of GFM
850 code blocks when backquote is pressed three times (default: `t`).
852 * `markdown-make-gfm-checkboxes-buttons` - Whether GitHub
853 Flavored Markdown style task lists (checkboxes) should be
854 turned into buttons that can be toggled with mouse-1 or RET. If
855 non-nil (default), then buttons are enabled. This works in
856 `markdown-mode` as well as `gfm-mode`.
858 * `markdown-hide-urls` - Determines whether URL and reference
859 labels are hidden for inline and reference links (default: `nil`).
860 When non-nil, inline links will appear in the buffer as
861 `[link](∞)` instead of
862 `[link](http://perhaps.a/very/long/url/)`. To change the
863 placeholder (composition) character used, set the variable
864 `markdown-url-compose-char`. URL hiding can be toggled
865 interactively using <kbd>C-c C-x C-l</kbd> (`markdown-toggle-url-hiding`)
866 or from the Markdown | Links & Images menu.
868 * `markdown-hide-markup` - Determines whether all possible markup
869 is hidden or otherwise beautified (default: `nil`). The actual
870 buffer text remains unchanged, but the display will be altered.
871 Brackets and URLs for links will be hidden, asterisks and
872 underscores for italic and bold text will be hidden, text
873 bullets for unordered lists will be replaced by Unicode
874 bullets, and so on. Since this includes URLs and reference
875 labels, when non-nil this setting supersedes `markdown-hide-urls`.
876 Markup hiding can be toggled using <kbd>C-c C-x C-m</kbd>
877 (`markdown-toggle-markup-hiding`) or from the Markdown | Show &
880 Unicode bullets are used to replace ASCII list item markers.
881 The list of characters used, in order of list level, can be
882 specified by setting the variable `markdown-list-item-bullets`.
883 The placeholder characters used to replace other markup can
884 be changed by customizing the corresponding variables:
885 `markdown-blockquote-display-char`,
886 `markdown-hr-display-char`, and
887 `markdown-definition-display-char`.
889 * `markdown-fontify-code-blocks-natively` - Whether to fontify
890 code in code blocks using the native major mode. This only
891 works for fenced code blocks where the language is specified
892 where we can automatically determine the appropriate mode to
893 use. The language to mode mapping may be customized by setting
894 the variable `markdown-code-lang-modes`. This can be toggled
895 interactively by pressing <kbd>C-c C-x C-f</kbd>
896 (`markdown-toggle-fontify-code-blocks-natively`).
898 * `markdown-gfm-uppercase-checkbox` - When non-nil, complete GFM
899 task list items with `[X]` instead of `[x]` (default: `nil`).
900 This is useful for compatibility with `org-mode`, which doesn't
901 recognize the lowercase variant.
903 * `markdown-translate-filename-function` - A function to be used to
904 translate filenames in links.
906 * `markdown-unordered-list-item-prefix` - When non-nil,
907 `markdown-insert-list-item` inserts enumerated numbers for
908 ordered list marker. While nil, it always inserts `1.`.
910 Additionally, the faces used for syntax highlighting can be modified to
911 your liking by issuing <kbd>M-x customize-group RET markdown-faces</kbd>
912 or by using the "Markdown Faces" link at the bottom of the mode
913 customization screen.
915 [Marked 2]: https://itunes.apple.com/us/app/marked-2/id890031187?mt=12&uo=4&at=11l5Vs&ct=mm
919 Besides supporting the basic Markdown syntax, Markdown Mode also
920 includes syntax highlighting for `[[Wiki Links]]`. This can be
921 enabled by setting `markdown-enable-wiki-links` to a non-nil value.
922 Wiki links may be followed by pressing <kbd>C-c C-o</kbd> when the point
923 is at a wiki link. Use <kbd>M-p</kbd> and <kbd>M-n</kbd> to quickly jump to the
924 previous and next links (including links of other types).
925 Aliased or piped wiki links of the form `[[link text|PageName]]`
926 are also supported. Since some wikis reverse these components, set
927 `markdown-wiki-link-alias-first` to nil to treat them as
928 `[[PageName|link text]]`. If `markdown-wiki-link-fontify-missing`
929 is also non-nil, Markdown Mode will highlight wiki links with
930 missing target file in a different color. By default, Markdown
931 Mode only searches for target files in the current directory.
932 You can control search type by setting `markdown-wiki-link-search-type`.
933 This value type is a symbol list. Possible values are
935 - `sub-directories` : search in sub directories
936 - `parent-directories` : search in parent directories
937 - `project` : search under project root
939 [SmartyPants][] support is possible by customizing `markdown-command`.
940 If you install `SmartyPants.pl` at, say, `/usr/local/bin/smartypants`,
941 then you can set `markdown-command` to `"markdown | smartypants"`.
942 You can do this either by using <kbd>M-x customize-group markdown</kbd>
943 or by placing the following in your `.emacs` file:
946 (setq markdown-command "markdown | smartypants")
949 [SmartyPants]: http://daringfireball.net/projects/smartypants/
951 Syntax highlighting for mathematical expressions written
952 in LaTeX (only expressions denoted by `$..$`, `$$..$$`, or `\[..\]`)
953 can be enabled by setting `markdown-enable-math` to a non-nil value,
954 either via customize or by placing `(setq markdown-enable-math t)`
955 in `.emacs`, and then restarting Emacs or calling
956 `markdown-reload-extensions`.
958 ## GitHub Flavored Markdown (GFM)
960 A [GitHub Flavored Markdown][GFM] mode, `gfm-mode`, is also
961 available. The GitHub implementation differs slightly from
962 standard Markdown in that it supports things like different
963 behavior for underscores inside of words, automatic linking of
964 URLs, strikethrough text, and fenced code blocks with an optional
967 The GFM-specific features above apply to `README.md` files, wiki
968 pages, and other Markdown-formatted files in repositories on
969 GitHub. GitHub also enables [additional features][GFM comments] for
970 writing on the site (for issues, pull requests, messages, etc.)
971 that are further extensions of GFM. These features include task
972 lists (checkboxes), newlines corresponding to hard line breaks,
973 auto-linked references to issues and commits, wiki links, and so
974 on. To make matters more confusing, although task lists are not
975 part of [GFM proper][GFM], [since 2014][] they are rendered (in a
976 read-only fashion) in all Markdown documents in repositories on the
977 site. These additional extensions are supported to varying degrees
978 by `markdown-mode` and `gfm-mode` as described below.
980 * **URL autolinking:** Both `markdown-mode` and `gfm-mode` support
981 highlighting of URLs without angle brackets.
983 * **Multiple underscores in words:** You must enable `gfm-mode` to
984 toggle support for underscores inside of words. In this mode
985 variable names such as `a_test_variable` will not trigger
988 * **Fenced code blocks:** Code blocks quoted with backquotes, with
989 optional programming language keywords, are highlighted in
990 both `markdown-mode` and `gfm-mode`. They can be inserted with
991 <kbd>C-c C-s C</kbd>. If there is an active region, the text in the
992 region will be placed inside the code block. You will be
993 prompted for the name of the language, but may press enter to
994 continue without naming a language.
996 In addition, in `gfm-mode`, GFM code blocks can be inserted via the
997 option `markdown-gfm-use-electric-backquote`. If the option
998 `markdown-code-block-braces` is set to `t`, code blocks inserted with
999 <kbd>C-c C-s C</kbd> or electric backquotes will include braces ("{}")
1000 around the language attributes.
1002 * **Strikethrough:** Strikethrough text is supported in both
1003 `markdown-mode` and `gfm-mode`. It can be inserted (and toggled)
1004 using <kbd>C-c C-s s</kbd>.
1006 * **Task lists:** GFM task lists will be rendered as checkboxes
1007 (Emacs buttons) in both `markdown-mode` and `gfm-mode` when
1008 `markdown-make-gfm-checkboxes-buttons` is set to a non-nil value
1009 (and it is set to t by default). These checkboxes can be
1010 toggled by clicking `mouse-1`, pressing <kbd>RET</kbd> over the button,
1011 or by pressing <kbd>C-c C-d</kbd> (`markdown-do`) with the point anywhere
1012 in the task list item. A normal list item can be turned to a
1013 check list item by the same command, or more specifically
1014 <kbd>C-c C-s [</kbd> (`markdown-insert-gfm-checkbox`).
1016 * **Wiki links:** Generic wiki links are supported in
1017 `markdown-mode`, but in `gfm-mode` specifically they will be
1018 treated as they are on GitHub: spaces will be replaced by hyphens
1019 in filenames and the first letter of the filename will be
1020 capitalized. For example, `[[wiki link]]` will map to a file
1021 named `Wiki-link` with the same extension as the current file.
1022 If a file with this name does not exist in the current directory,
1023 the first match in a subdirectory, if any, will be used instead.
1025 * **Newlines:** Neither `markdown-mode` nor `gfm-mode` do anything
1026 specifically with respect to newline behavior. If you use
1027 `gfm-mode` mostly to write text for comments or issues on the
1028 GitHub site--where newlines are significant and correspond to
1029 hard line breaks--then you may want to enable `visual-line-mode`
1030 for line wrapping in buffers. You can do this with a
1031 `gfm-mode-hook` as follows:
1034 ;; Use visual-line-mode in gfm-mode
1035 (defun my-gfm-mode-hook ()
1036 (visual-line-mode 1))
1037 (add-hook 'gfm-mode-hook 'my-gfm-mode-hook)
1040 * **Preview:** GFM-specific preview can be powered by setting
1041 `markdown-command` to use [Docter][]. This may also be
1042 configured to work with [Marked 2][] for `markdown-open-command`.
1044 [GFM]: http://github.github.com/github-flavored-markdown/
1045 [GFM comments]: https://help.github.com/articles/writing-on-github/
1046 [since 2014]: https://github.com/blog/1825-task-lists-in-all-markdown-documents
1047 [Docter]: https://github.com/alampros/Docter
1051 markdown-mode has benefited greatly from the efforts of the many
1052 volunteers who have sent patches, test cases, bug reports,
1053 suggestions, helped with packaging, etc. Thank you for your
1054 contributions! See the [contributors graph][contrib] for details.
1056 [contrib]: https://github.com/jrblevin/markdown-mode/graphs/contributors
1060 markdown-mode is developed and tested primarily for compatibility
1061 with GNU Emacs 25.1 and later. If you find any bugs in
1062 markdown-mode, please construct a test case or a patch and open a
1063 ticket on the [GitHub issue tracker][issues]. See the
1064 contributing guidelines in `CONTRIBUTING.md` for details on
1065 creating pull requests.
1067 [issues]: https://github.com/jrblevin/markdown-mode/issues
1071 markdown-mode was written and is maintained by Jason Blevins. The
1072 first version was released on May 24, 2007.
1074 * 2007-05-24: [Version 1.1][]
1075 * 2007-05-25: [Version 1.2][]
1076 * 2007-06-05: [Version 1.3][]
1077 * 2007-06-29: [Version 1.4][]
1078 * 2007-10-11: [Version 1.5][]
1079 * 2008-06-04: [Version 1.6][]
1080 * 2009-10-01: [Version 1.7][]
1081 * 2011-08-12: [Version 1.8][]
1082 * 2011-08-15: [Version 1.8.1][]
1083 * 2013-01-25: [Version 1.9][]
1084 * 2013-03-24: [Version 2.0][]
1085 * 2016-01-09: [Version 2.1][]
1086 * 2017-05-26: [Version 2.2][]
1087 * 2017-08-31: [Version 2.3][]
1088 * 2020-05-30: [Version 2.4][]
1090 [Version 1.1]: https://jblevins.org/projects/markdown-mode/rev-1-1
1091 [Version 1.2]: https://jblevins.org/projects/markdown-mode/rev-1-2
1092 [Version 1.3]: https://jblevins.org/projects/markdown-mode/rev-1-3
1093 [Version 1.4]: https://jblevins.org/projects/markdown-mode/rev-1-4
1094 [Version 1.5]: https://jblevins.org/projects/markdown-mode/rev-1-5
1095 [Version 1.6]: https://jblevins.org/projects/markdown-mode/rev-1-6
1096 [Version 1.7]: https://jblevins.org/projects/markdown-mode/rev-1-7
1097 [Version 1.8]: https://jblevins.org/projects/markdown-mode/rev-1-8
1098 [Version 1.8.1]: https://jblevins.org/projects/markdown-mode/rev-1-8-1
1099 [Version 1.9]: https://jblevins.org/projects/markdown-mode/rev-1-9
1100 [Version 2.0]: https://jblevins.org/projects/markdown-mode/rev-2-0
1101 [Version 2.1]: https://jblevins.org/projects/markdown-mode/rev-2-1
1102 [Version 2.2]: https://jblevins.org/projects/markdown-mode/rev-2-2
1103 [Version 2.3]: https://jblevins.org/projects/markdown-mode/rev-2-3
1104 [Version 2.4]: https://github.com/jrblevin/markdown-mode/releases/tag/v2.4