1 # Emacs Markdown Mode [![MELPA badge][melpa-badge]][melpa-link] [![MELPA stable badge][melpa-stable-badge]][melpa-stable-link] [![Travis CI Build Status][travis-badge]][travis-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 [travis-link]: https://travis-ci.org/jrblevin/markdown-mode
8 [travis-badge]: https://travis-ci.org/jrblevin/markdown-mode.svg?branch=master
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.3, released on
14 August 31, 2017. 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://jblevins.org/projects/markdown-mode/rev-2-3
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 either `.md` or `.markdown`.
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 :commands (markdown-mode gfm-mode)
83 :mode (("README\\.md\\'" . gfm-mode)
84 ("\\.md\\'" . markdown-mode)
85 ("\\.markdown\\'" . markdown-mode))
86 :init (setq markdown-command "multimarkdown"))
89 [MELPA Stable]: http://stable.melpa.org/
90 [use-package]: https://github.com/jwiegley/use-package
94 Alternatively you can manually download and install markdown-mode.
95 First, download the [latest stable version][markdown-mode.el] and
96 save the file where Emacs can find it (i.e., a directory in your
97 `load-path`). You can then configure `markdown-mode` and `gfm-mode`
98 to load automatically by adding the following to your init file:
101 (autoload 'markdown-mode "markdown-mode"
102 "Major mode for editing Markdown files" t)
103 (add-to-list 'auto-mode-alist '("\\.markdown\\'" . markdown-mode))
104 (add-to-list 'auto-mode-alist '("\\.md\\'" . markdown-mode))
106 (autoload 'gfm-mode "markdown-mode"
107 "Major mode for editing GitHub Flavored Markdown files" t)
108 (add-to-list 'auto-mode-alist '("README\\.md\\'" . gfm-mode))
111 [markdown-mode.el]: https://jblevins.org/projects/markdown-mode/markdown-mode.el
113 **Development Version**
115 To follow or contribute to markdown-mode development, you can
116 browse or clone the Git repository
117 [on GitHub](https://github.com/jrblevin/markdown-mode):
120 git clone https://github.com/jrblevin/markdown-mode.git
123 If you prefer to install and use the development version, which may
124 become unstable at some times, you can either clone the Git
125 repository as above or install markdown-mode from
126 [MELPA](https://melpa.org/#/markdown-mode).
128 If you clone the repository directly, then make sure that Emacs can
129 find it by adding the following line to your startup file:
132 (add-to-list 'load-path "/path/to/markdown-mode/repository")
135 **Packaged Installation**
137 markdown-mode is also available in several package managers. You
138 may want to confirm that the package you install contains the
139 latest stable version first (and please notify the package
142 * Debian Linux: [elpa-markdown-mode][] and [emacs-goodies-el][]
143 * Ubuntu Linux: [elpa-markdown-mode][elpa-ubuntu] and [emacs-goodies-el][emacs-goodies-el-ubuntu]
144 * RedHat and Fedora Linux: [emacs-goodies][]
145 * NetBSD: [textproc/markdown-mode][]
146 * MacPorts: [markdown-mode.el][macports-package] ([pending][macports-ticket])
147 * FreeBSD: [textproc/markdown-mode.el][freebsd-port]
149 [elpa-markdown-mode]: https://packages.debian.org/sid/lisp/elpa-markdown-mode
150 [elpa-ubuntu]: http://packages.ubuntu.com/search?keywords=elpa-markdown-mode
151 [emacs-goodies-el]: http://packages.debian.org/emacs-goodies-el
152 [emacs-goodies-el-ubuntu]: http://packages.ubuntu.com/search?keywords=emacs-goodies-el
153 [emacs-goodies]: https://apps.fedoraproject.org/packages/emacs-goodies
154 [textproc/markdown-mode]: http://pkgsrc.se/textproc/markdown-mode
155 [macports-package]: https://trac.macports.org/browser/trunk/dports/editors/markdown-mode.el/Portfile
156 [macports-ticket]: http://trac.macports.org/ticket/35716
157 [freebsd-port]: http://svnweb.freebsd.org/ports/head/textproc/markdown-mode.el
161 To enable editing of code blocks in indirect buffers using <kbd>C-c '</kbd>,
162 you will need to install the [`edit-indirect`][ei] package.
164 [ei]: https://github.com/Fanael/edit-indirect/
168 Keybindings are grouped by prefixes based on their function. For
169 example, the commands for styling text are grouped under <kbd>C-c C-s</kbd>
170 and toggle commands begin with <kbd>C-c C-x</kbd>. The primary commands in
171 each group will are described below. You can obtain a list of all
172 keybindings by pressing <kbd>C-c C-h</kbd>. Movement and shifting commands
173 tend to be associated with paired delimiters such as <kbd>M-{</kbd> and
174 <kbd>M-}</kbd> or <kbd>C-c <</kbd> and <kbd>C-c ></kbd>. Outline navigation keybindings the
175 same as in `org-mode`. Finally, commands for running Markdown or
176 doing maintenance on an open file are grouped under the <kbd>C-c C-c</kbd>
177 prefix. The most commonly used commands are described below. You
178 can obtain a list of all keybindings by pressing <kbd>C-c C-h</kbd>.
180 * Links and Images: <kbd>C-c C-l</kbd> and <kbd>C-c C-i</kbd>
182 <kbd>C-c C-l</kbd> (`markdown-insert-link`) is a general command for
183 inserting new link markup or editing existing link markup. This
184 is especially useful when markup or URL hiding is enabled, so
185 that URLs can't easily be edited directly. This command can be
186 used to insert links of any form: either inline links,
187 reference links, or plain URLs in angle brackets. The URL or
188 `[reference]` label, link text, and optional title are entered
189 through a series of interactive prompts. The type of link is
190 determined by which values are provided:
192 * If both a URL and link text are given, insert an inline link:
194 * If both a `[reference]` label and link text are given, insert
195 a reference link: `[text][reference]`.
196 * If only link text is given, insert an implicit reference link:
198 * If only a URL is given, insert a plain URL link:
201 Similarly, <kbd>C-c C-i</kbd> (`markdown-insert-image`) is a general
202 command for inserting or editing image markup. As with the link
203 insertion command, through a series interactive prompts you can
204 insert either an inline or reference image:
206 * If both a URL and alt text are given, insert an inline
207 image: `![alt text](url)`.
208 * If both a `[reference]` label and alt text are given,
209 insert a reference link: `![alt text][reference]`.
211 If there is an existing link or image at the point, these
212 command will edit the existing markup rather than inserting new
213 markup. Otherwise, if there is an active region, these commands
214 use the region as either the default URL (if it seems to be a
215 URL) or link text value otherwise. In that case, the region
216 will be deleted and replaced by the link.
218 Note that these functions can be used to convert links and
219 images from one type to another (inline, reference, or plain
220 URL) by selectively adding or removing properties via the
223 If a reference label is given that is not yet defined, you
224 will be prompted for the URL and optional title and the
225 reference will be inserted according to the value of
226 `markdown-reference-location`. If a title is given, it will be
227 added to the end of the reference definition and will be used
228 to populate the title attribute when converted to HTML.
230 Local images associated with image links may be displayed
231 inline in the buffer by pressing <kbd>C-c C-x C-i</kbd>
232 (`markdown-toggle-inline-images`). This is a toggle command, so
233 pressing this once again will remove inline images. Large
234 images may be scaled down to fit in the buffer using
235 `markdown-max-image-size`, a cons cell of the form
236 `(max-width . max-height)`. Resizing requires Emacs to be
237 built with ImageMagick support.
239 * Text Styles: <kbd>C-c C-s</kbd>
241 <kbd>C-c C-s i</kbd> inserts markup to make a region or word italic. If
242 there is an active region, make the region italic. If the point
243 is at a non-italic word, make the word italic. If the point is
244 at an italic word or phrase, remove the italic markup.
245 Otherwise, simply insert italic delimiters and place the point
246 in between them. Similarly, use <kbd>C-c C-s b</kbd> for bold, <kbd>C-c C-s c</kbd>
247 for inline code, and <kbd>C-c C-s k</kbd> for inserting `<kbd>` tags.
249 <kbd>C-c C-s q</kbd> inserts a blockquote using the active region, if
250 any, or starts a new blockquote. <kbd>C-c C-s Q</kbd> is a variation
251 which always operates on the region, regardless of whether it
252 is active or not (i.e., when `transient-mark-mode` is off but
253 the mark is set). The appropriate amount of indentation, if
254 any, is calculated automatically given the surrounding context,
255 but may be adjusted later using the region indentation
258 <kbd>C-c C-s p</kbd> behaves similarly for inserting preformatted code
259 blocks (with <kbd>C-c C-s P</kbd> being the region-only counterpart)
260 and <kbd>C-c C-s C</kbd> inserts a GFM style backquote fenced code block.
262 * Headings: <kbd>C-c C-s</kbd>
264 To insert or replace headings, there are two options. You can
265 insert a specific level heading directly or you can have
266 `markdown-mode` determine the level for you based on the previous
267 heading. As with the other markup commands, the heading
268 insertion commands use the text in the active region, if any,
269 as the heading text. Otherwise, if the current line is not
270 blank, they use the text on the current line. Finally, the
271 setext commands will prompt for heading text if there is no
272 active region and the current line is blank.
274 <kbd>C-c C-s h</kbd> inserts a heading with automatically chosen type and
275 level (both determined by the previous heading). <kbd>C-c C-s H</kbd>
276 behaves similarly, but uses setext (underlined) headings when
277 possible, still calculating the level automatically.
278 In cases where the automatically-determined level is not what
279 you intended, the level can be quickly promoted or demoted
280 (as described below). Alternatively, a <kbd>C-u</kbd> prefix can be
281 given to insert a heading _promoted_ (lower number) by one
282 level or a <kbd>C-u C-u</kbd> prefix can be given to insert a heading
283 demoted (higher number) by one level.
285 To insert a heading of a specific level and type, use <kbd>C-c C-s 1</kbd>
286 through <kbd>C-c C-s 6</kbd> for atx (hash mark) headings and <kbd>C-c C-s !</kbd> or
287 <kbd>C-c C-s @</kbd> for setext headings of level one or two, respectively.
288 Note that <kbd>!</kbd> is <kbd>S-1</kbd> and <kbd>@</kbd> is <kbd>S-2</kbd>.
290 If the point is at a heading, these commands will replace the
291 existing markup in order to update the level and/or type of the
292 heading. To remove the markup of the heading at the point,
293 press <kbd>C-c C-k</kbd> to kill the heading and press <kbd>C-y</kbd> to yank the
294 heading text back into the buffer.
296 * Horizontal Rules: <kbd>C-c C-s -</kbd>
298 <kbd>C-c C-s -</kbd> inserts a horizontal rule. By default, insert the
299 first string in the list `markdown-hr-strings` (the most
300 prominent rule). With a <kbd>C-u</kbd> prefix, insert the last string.
301 With a numeric prefix <kbd>N</kbd>, insert the string in position <kbd>N</kbd>
304 * Footnotes: <kbd>C-c C-s f</kbd>
306 <kbd>C-c C-s f</kbd> inserts a footnote marker at the point, inserts a
307 footnote definition below, and positions the point for
308 inserting the footnote text. Note that footnotes are an
309 extension to Markdown and are not supported by all processors.
311 * Wiki Links: <kbd>C-c C-s w</kbd>
313 <kbd>C-c C-s w</kbd> inserts a wiki link of the form `[[WikiLink]]`. If
314 there is an active region, use the region as the link text. If the
315 point is at a word, use the word as the link text. If there is
316 no active region and the point is not at word, simply insert
317 link markup. Note that wiki links are an extension to Markdown
318 and are not supported by all processors.
320 * Markdown and Maintenance Commands: <kbd>C-c C-c</kbd>
322 *Compile:* <kbd>C-c C-c m</kbd> will run Markdown on the current buffer
323 and show the output in another buffer. *Preview*: <kbd>C-c C-c p</kbd>
324 runs Markdown on the current buffer and previews, stores the
325 output in a temporary file, and displays the file in a browser.
326 *Export:* <kbd>C-c C-c e</kbd> will run Markdown on the current buffer
327 and save the result in the file `basename.html`, where
328 `basename` is the name of the Markdown file with the extension
329 removed. *Export and View:* press <kbd>C-c C-c v</kbd> to export the
330 file and view it in a browser. *Open:* <kbd>C-c C-c o</kbd> will open
331 the Markdown source file directly using `markdown-open-command`.
332 *Live Export*: Press <kbd>C-c C-c l</kbd> to turn on
333 `markdown-live-preview-mode` to view the exported output
334 side-by-side with the source Markdown. **For all export commands,
335 the output file will be overwritten without notice.**
336 `markdown-live-preview-window-function` can be customized to open
337 in a browser other than `eww`. If you want to force the
338 preview window to appear at the bottom or right, you can
339 customize `markdown-split-window-direction`.
343 - <kbd>C-c C-c m</kbd>: `markdown-command` > `*markdown-output*` buffer.
344 - <kbd>C-c C-c p</kbd>: `markdown-command` > temporary file > browser.
345 - <kbd>C-c C-c e</kbd>: `markdown-command` > `basename.html`.
346 - <kbd>C-c C-c v</kbd>: `markdown-command` > `basename.html` > browser.
347 - <kbd>C-c C-c w</kbd>: `markdown-command` > kill ring.
348 - <kbd>C-c C-c o</kbd>: `markdown-open-command`.
349 - <kbd>C-c C-c l</kbd>: `markdown-live-preview-mode` > `*eww*` buffer.
351 <kbd>C-c C-c c</kbd> will check for undefined references. If there are
352 any, a small buffer will open with a list of undefined
353 references and the line numbers on which they appear. In Emacs
354 22 and greater, selecting a reference from this list and
355 pressing <kbd>RET</kbd> will insert an empty reference definition at the
356 end of the buffer. Similarly, selecting the line number will
357 jump to the corresponding line.
359 <kbd>C-c C-c n</kbd> renumbers any ordered lists in the buffer that are
362 <kbd>C-c C-c ]</kbd> completes all headings and normalizes all horizontal
365 * Following Links: <kbd>C-c C-o</kbd>
367 Press <kbd>C-c C-o</kbd> when the point is on an inline or reference
368 link to open the URL in a browser. When the point is at a
369 wiki link, open it in another buffer (in the current window,
370 or in the other window with the <kbd>C-u</kbd> prefix). Use <kbd>M-p</kbd> and
371 <kbd>M-n</kbd> to quickly jump to the previous or next link of any type.
373 * Doing Things: <kbd>C-c C-d</kbd>
375 Use <kbd>C-c C-d</kbd> to do something sensible with the object at the point:
377 - Jumps between reference links and reference definitions.
378 If more than one link uses the same reference label, a
379 window will be shown containing clickable buttons for
380 jumping to each link. Pressing <kbd>TAB</kbd> or <kbd>S-TAB</kbd> cycles
381 between buttons in this window.
382 - Jumps between footnote markers and footnote text.
383 - Toggles the completion status of GFM task list items
385 - Re-aligns table columns.
387 * Promotion and Demotion: <kbd>C-c C--</kbd> and <kbd>C-c C-=</kbd>
389 Headings, horizontal rules, and list items can be promoted and
390 demoted, as well as bold and italic text. For headings,
391 "promotion" means *decreasing* the level (i.e., moving from
392 `<h2>` to `<h1>`) while "demotion" means *increasing* the
393 level. For horizontal rules, promotion and demotion means
394 moving backward or forward through the list of rule strings in
395 `markdown-hr-strings`. For bold and italic text, promotion and
396 demotion means changing the markup from underscores to asterisks.
397 Press <kbd>C-c C--</kbd> or <kbd>C-c LEFT</kbd> to promote the element at the point
400 To remember these commands, note that <kbd>-</kbd> is for decreasing the
401 level (promoting), and <kbd>=</kbd> (on the same key as <kbd>+</kbd>) is for
402 increasing the level (demoting). Similarly, the left and right
403 arrow keys indicate the direction that the atx heading markup
404 is moving in when promoting or demoting.
406 * Completion: <kbd>C-c C-]</kbd>
408 Complete markup is in normalized form, which means, for
409 example, that the underline portion of a setext header is the
410 same length as the heading text, or that the number of leading
411 and trailing hash marks of an atx header are equal and that
412 there is no extra whitespace in the header text. <kbd>C-c C-]</kbd>
413 completes the markup at the point, if it is determined to be
416 * 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>
418 New list items can be inserted with <kbd>M-RET</kbd> or <kbd>C-c C-j</kbd>. This
419 command determines the appropriate marker (one of the possible
420 unordered list markers or the next number in sequence for an
421 ordered list) and indentation level by examining nearby list
422 items. If there is no list before or after the point, start a
423 new list. As with heading insertion, you may prefix this
424 command by <kbd>C-u</kbd> to decrease the indentation by one level.
425 Prefix this command by <kbd>C-u C-u</kbd> to increase the indentation by
428 Existing list items (and their nested sub-items) can be moved
429 up or down with <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> and indented or
430 outdented with <kbd>C-c RIGHT</kbd> or <kbd>C-c LEFT</kbd>.
432 * Editing Subtrees: <kbd>C-c UP</kbd>, <kbd>C-c DOWN</kbd>, <kbd>C-c LEFT</kbd>, and <kbd>C-c RIGHT</kbd>
434 Entire subtrees of ATX headings can be promoted and demoted
435 with <kbd>C-c LEFT</kbd> and <kbd>C-c RIGHT</kbd>, which are the same keybindings
436 used for promotion and demotion of list items. If the point is in
437 a list item, the operate on the list item. Otherwise, they operate
438 on the current heading subtree. Similarly, subtrees can be
439 moved up and down with <kbd>C-c UP</kbd> and <kbd>C-c DOWN</kbd>.
441 These commands currently do not work properly if there are
442 Setext headings in the affected region.
444 Please note the following "boundary" behavior for promotion and
445 demotion. Any level-six headings will not be demoted further
446 (i.e., they remain at level six, since Markdown and HTML define
447 only six levels) and any level-one headings will promoted away
448 entirely (i.e., heading markup will be removed, since a
449 level-zero heading is not defined).
451 * Shifting the Region: <kbd>C-c <</kbd> and <kbd>C-c ></kbd>
453 Text in the region can be indented or outdented as a group using
454 <kbd>C-c ></kbd> to indent to the next indentation point (calculated in
455 the current context), and <kbd>C-c <</kbd> to outdent to the previous
456 indentation point. These keybindings are the same as those for
457 similar commands in `python-mode`.
459 * Killing Elements: <kbd>C-c C-k</kbd>
461 Press <kbd>C-c C-k</kbd> to kill the thing at point and add important
462 text, without markup, to the kill ring. Possible things to
463 kill include (roughly in order of precedece): inline code,
464 headings, horizonal rules, links (add link text to kill ring),
465 images (add alt text to kill ring), angle URIs, email
466 addresses, bold, italics, reference definitions (add URI to
467 kill ring), footnote markers and text (kill both marker and
468 text, add text to kill ring), and list items.
470 * 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>
472 These keys are used for hierarchical navigation in lists and
473 headings. When the point is in a list, they move between list
474 items. Otherwise, they move between headings. Use <kbd>C-c C-n</kbd> and
475 <kbd>C-c C-p</kbd> to move between the next and previous visible
476 headings or list items of any level. Similarly, <kbd>C-c C-f</kbd> and
477 <kbd>C-c C-b</kbd> move to the next and previous visible headings or
478 list items at the same level as the one at the point. Finally,
479 <kbd>C-c C-u</kbd> will move up to the parent heading or list item.
481 * Movement by Markdown paragraph: <kbd>M-{</kbd>, <kbd>M-}</kbd>, and <kbd>M-h</kbd>
483 Paragraphs in `markdown-mode` are regular paragraphs,
484 paragraphs inside blockquotes, individual list items, headings,
485 etc. These keys are usually bound to `forward-paragraph` and
486 `backward-paragraph`, but the built-in Emacs functions are
487 based on simple regular expressions that fail in Markdown
488 files. Instead, they are bound to `markdown-forward-paragraph`
489 and `markdown-backward-paragraph`. To mark a paragraph,
490 you can use <kbd>M-h</kbd> (`markdown-mark-paragraph`).
492 * Movement by Markdown block: <kbd>C-M-{</kbd>, <kbd>C-M-}</kbd>, and <kbd>C-c M-h</kbd>
494 Markdown blocks are regular paragraphs in many cases, but
495 contain many paragraphs in other cases: blocks are considered
496 to be entire lists, entire code blocks, and entire blockquotes.
497 To move backward one block use <kbd>C-M-{</kbd>
498 (`markdown-beginning-block`) and to move forward use <kbd>C-M-}</kbd>
499 (`markdown-end-of-block`). To mark a block, use <kbd>C-c M-h</kbd>
500 (`markdown-mark-block`).
502 * Movement by Defuns: <kbd>C-M-a</kbd>, <kbd>C-M-e</kbd>, and <kbd>C-M-h</kbd>
504 The usual Emacs commands can be used to move by defuns
505 (top-level major definitions). In markdown-mode, a defun is a
506 section. As usual, <kbd>C-M-a</kbd> will move the point to the
507 beginning of the current or preceding defun, <kbd>C-M-e</kbd> will move
508 to the end of the current or following defun, and <kbd>C-M-h</kbd> will
509 put the region around the entire defun.
513 Markdown Mode includes support for editing tables, which
514 have the following basic format:
516 | Right | Left | Center | Default |
517 |------:|:-----|:------:|---------|
518 | 12 | 12 | 12 | 12 |
519 | 123 | 123 | 123 | 123 |
522 The first line contains column headers. The second line
523 contains a separator line between the headers and the content.
524 Each following line is a row in the table. Columns are always
525 separated by the pipe character. The colons indicate column
528 A table is re-aligned automatically each time you press <kbd>TAB</kbd>
529 or <kbd>RET</kbd> inside the table. <kbd>TAB</kbd> also moves to the next
530 field (<kbd>RET</kbd> to the next row) and creates new table rows at
531 the end of the table or before horizontal separator lines. The
532 indentation of the table is set by the first line. Column
533 centering inside Emacs is not supported.
535 Beginning pipe characters are required for proper detection of
536 table borders inside Emacs. Any line starting with `|-` or `|:`
537 is considered as a horizontal separator line and will be
538 expanded on the next re-align to span the whole table width. No
539 padding is allowed between the beginning pipe character and
540 header separator symbol. So, to create the above table, you
543 |Right|Left|Center|Default|
546 and then press <kbd>TAB</kbd> to align the table and start filling in
549 Then you can jump with <kbd>TAB</kbd> from one cell to the next or with
550 <kbd>S-TAB</kbd> to the previous one. <kbd>RET</kbd> will jump to the to the
551 next cell in the same column, and create a new row if there is
552 no such cell or if the next row is beyond a separator line.
554 You can also convert selected region to a table. Basic editing
555 capabilities include inserting, deleting, and moving of columns
556 and rows, and table re-alignment, sorting, transposition:
558 - <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> - Move the current row up or down.
559 - <kbd>C-c LEFT</kbd> or <kbd>C-c RIGHT</kbd> - Move the current column left or right.
560 - <kbd>C-c S-UP</kbd> - Kill the current row.
561 - <kbd>C-c S-DOWN</kbd> - Insert a row above the current row. With a
562 prefix argument, row line is created below the current one.
563 - <kbd>C-c S-LEFT</kbd> - Kill the current column.
564 - <kbd>C-c S-RIGHT</kbd> - Insert a new column to the left of the current one.
565 - <kbd>C-c C-d</kbd> - Re-align the current table (`markdown-do`).
566 - <kbd>C-c C-c ^</kbd> - Sort the rows of a table by a specified column.
567 This command prompts you for the column number and a sort
568 method (alphabetical or numerical, optionally in reverse).
569 - <kbd>C-c C-c |</kbd> - Convert the region to a table. This function
570 attempts to recognize comma, tab, and space separated data
571 and then splits the data into cells accordingly.
572 - <kbd>C-c C-c t</kbd> - Transpose table at point.
574 The table editing functions try to handle markup hiding
575 correctly when calculating column widths, however, columns
576 containing hidden markup may not always be aligned properly.
578 * Miscellaneous Commands:
580 When the [`edit-indirect`][ei] package is installed, <kbd>C-c '</kbd>
581 (`markdown-edit-code-block`) can be used to edit a code block
582 in an indirect buffer in the native major mode. Press <kbd>C-c C-c</kbd>
583 to commit changes and return or <kbd>C-c C-k</kbd> to cancel. You can
584 also give a prefix argument to the insertion command, as in
585 <kbd>C-u C-c C-s C</kbd>, to edit the code block in an indirect buffer
588 As noted, many of the commands above behave differently depending
589 on whether Transient Mark mode is enabled or not. When it makes
590 sense, if Transient Mark mode is on and the region is active, the
591 command applies to the text in the region (e.g., <kbd>C-c C-s b</kbd> makes the
592 region bold). For users who prefer to work outside of Transient
593 Mark mode, since Emacs 22 it can be enabled temporarily by pressing
594 <kbd>C-SPC C-SPC</kbd>. When this is not the case, many commands then
595 proceed to look work with the word or line at the point.
597 When applicable, commands that specifically act on the region even
598 outside of Transient Mark mode have the same keybinding as their
599 standard counterpart, but the letter is uppercase. For example,
600 `markdown-insert-blockquote` is bound to <kbd>C-c C-s q</kbd> and only acts on
601 the region in Transient Mark mode while `markdown-blockquote-region`
602 is bound to <kbd>C-c C-s Q</kbd> and always applies to the region (when nonempty).
604 Note that these region-specific functions are useful in many
605 cases where it may not be obvious. For example, yanking text from
606 the kill ring sets the mark at the beginning of the yanked text
607 and moves the point to the end. Therefore, the (inactive) region
608 contains the yanked text. So, <kbd>C-y</kbd> followed by <kbd>C-c C-s Q</kbd> will
609 yank text and turn it into a blockquote.
611 markdown-mode attempts to be flexible in how it handles
612 indentation. When you press <kbd>TAB</kbd> repeatedly, the point will cycle
613 through several possible indentation levels corresponding to things
614 you might have in mind when you press <kbd>RET</kbd> at the end of a line or
615 <kbd>TAB</kbd>. For example, you may want to start a new list item,
616 continue a list item with hanging indentation, indent for a nested
617 pre block, and so on. Outdenting is handled similarly when backspace
618 is pressed at the beginning of the non-whitespace portion of a line.
620 markdown-mode supports outline-minor-mode as well as org-mode-style
621 visibility cycling for atx- or hash-style headings. There are two
622 types of visibility cycling: Pressing <kbd>S-TAB</kbd> cycles globally between
623 the table of contents view (headings only), outline view (top-level
624 headings only), and the full document view. Pressing <kbd>TAB</kbd> while the
625 point is at a heading will cycle through levels of visibility for the
626 subtree: completely folded, visible children, and fully visible.
627 Note that mixing hash and underline style headings will give undesired
632 Although no configuration is *necessary* there are a few things
633 that can be customized. The <kbd>M-x customize-mode</kbd> command
634 provides an interface to all of the possible customizations:
636 * `markdown-command` - the command used to run Markdown (default:
637 `markdown`). This variable may be customized to pass
638 command-line options to your Markdown processor of choice. It can
639 also be a function; in this case `markdown` will call it with three
640 arguments: the beginning and end of the region to process, and
641 a buffer to write the output to.
643 * `markdown-command-needs-filename` - set to `t` if
644 `markdown-command` does not accept standard input (default:
645 `nil`). When `nil`, `markdown-mode` will pass the Markdown
646 content to `markdown-command` using standard input (`stdin`).
647 When set to `t`, `markdown-mode` will pass the name of the file
648 as the final command-line argument to `markdown-command`. Note
649 that in the latter case, you will only be able to run
650 `markdown-command` from buffers which are visiting a file. If
651 `markdown-command` is a function, `markdown-command-needs-filename`
654 * `markdown-open-command` - the command used for calling a standalone
655 Markdown previewer which is capable of opening Markdown source files
656 directly (default: `nil`). This command will be called
657 with a single argument, the filename of the current buffer.
658 A representative program is the Mac app [Marked 2][], a
659 live-updating Markdown previewer which can be [called from a
660 simple shell script](https://jblevins.org/log/marked-2-command).
661 This variable can also be a function; in this case `markdown-open`
662 will call it without arguments to preview the current buffer.
664 * `markdown-hr-strings` - list of strings to use when inserting
665 horizontal rules. Different strings will not be distinguished
666 when converted to HTML--they will all be converted to
667 `<hr/>`--but they may add visual distinction and style to plain
668 text documents. To maintain some notion of promotion and
669 demotion, keep these sorted from largest to smallest.
671 * `markdown-bold-underscore` - set to a non-nil value to use two
672 underscores when inserting bold text instead of two asterisks
675 * `markdown-italic-underscore` - set to a non-nil value to use
676 underscores when inserting italic text instead of asterisks
679 * `markdown-asymmetric-header` - set to a non-nil value to use
680 asymmetric header styling, placing header characters only on
681 the left of headers (default: `nil`).
683 * `markdown-header-scaling` - set to a non-nil value to use
684 a variable-pitch font for headings where the size corresponds
685 to the level of the heading (default: `nil`).
687 * `markdown-header-scaling-values` - list of scaling values,
688 relative to baseline, for headers of levels one through six,
689 used when `markdown-header-scaling` is non-nil
690 (default: `(2.0 1.7 1.4 1.1 1.0 1.0)`).
692 * `markdown-marginalize-headers` - put opening atx header markup
693 in the left margin when non-nil (default: `nil`).
695 * `markdown-marginalize-headers-margin-width` - width of margin
696 used for marginalized headers (default: 6).
698 * `markdown-list-indent-width` - depth of indentation for lists
699 when inserting, promoting, and demoting list items (default: 4).
701 * `markdown-indent-function` - the function to use for automatic
702 indentation (default: `markdown-indent-line`).
704 * `markdown-indent-on-enter` - Set to a non-nil value to
705 automatically indent new lines when <kbd>RET</kbd> is pressed.
706 Set to `indent-and-new-item` to additionally continue lists
707 when <kbd>RET</kbd> is pressed (default: `t`).
709 * `markdown-enable-wiki-links` - syntax highlighting for wiki
710 links (default: `nil`). Set this to a non-nil value to turn on
711 wiki link support by default. Wiki link support can be toggled
712 later using the function `markdown-toggle-wiki-links`."
714 * `markdown-wiki-link-alias-first` - set to a non-nil value to
715 treat aliased wiki links like `[[link text|PageName]]`
716 (default: `t`). When set to nil, they will be treated as
717 `[[PageName|link text]]`.
719 * `markdown-uri-types` - a list of protocol schemes (e.g., "http")
720 for URIs that `markdown-mode` should highlight.
722 * `markdown-enable-math` - font lock for inline and display LaTeX
723 math expressions (default: `nil`). Set this to `t` to turn on
724 math support by default. Math support can be toggled
725 interactively later using <kbd>C-c C-x C-e</kbd>
726 (`markdown-toggle-math`).
728 * `markdown-enable-html` - font lock for HTML tags and attributes
731 * `markdown-css-paths` - CSS files to link to in XHTML output
734 * `markdown-content-type` - when set to a nonempty string, an
735 `http-equiv` attribute will be included in the XHTML `<head>`
736 block (default: `""`). If needed, the suggested values are
737 `application/xhtml+xml` or `text/html`. See also:
738 `markdown-coding-system`.
740 * `markdown-coding-system` - used for specifying the character
741 set identifier in the `http-equiv` attribute when included
742 (default: `nil`). See `markdown-content-type`, which must
743 be set before this variable has any effect. When set to `nil`,
744 `buffer-file-coding-system` will be used to automatically
745 determine the coding system string (falling back to
746 `iso-8859-1` when unavailable). Common settings are `utf-8`
749 * `markdown-xhtml-header-content` - additional content to include
750 in the XHTML `<head>` block (default: `""`).
752 * `markdown-xhtml-standalone-regexp` - a regular expression which
753 `markdown-mode` uses to determine whether the output of
754 `markdown-command` is a standalone XHTML document or an XHTML
755 fragment (default: `"^\\(<\\?xml\\|<!DOCTYPE\\|<html\\)"`). If
756 this regular expression not matched in the first five lines of
757 output, `markdown-mode` assumes the output is a fragment and
758 adds a header and footer.
760 * `markdown-link-space-sub-char` - a character to replace spaces
761 when mapping wiki links to filenames (default: `"_"`).
762 For example, use an underscore for compatibility with the
763 Python Markdown WikiLinks extension. In `gfm-mode`, this is
764 set to `"-"` to conform with GitHub wiki links.
766 * `markdown-reference-location` - where to insert reference
767 definitions (default: `header`). The possible locations are
768 the end of the document (`end`), after the current block
769 (`immediately`), the end of the current subtree (`subtree`),
770 or before the next header (`header`).
772 * `markdown-footnote-location` - where to insert footnote text
773 (default: `end`). The set of location options is the same as
774 for `markdown-reference-location`.
776 * `markdown-nested-imenu-heading-index` - Use nested imenu
777 heading instead of a flat index (default: `t`). A nested
778 index may provide more natural browsing from the menu, but a
779 flat list may allow for faster keyboard navigation via tab
782 * `comment-auto-fill-only-comments` - variable is made
783 buffer-local and set to `nil` by default. In programming
784 language modes, when this variable is non-nil, only comments
785 will be filled by auto-fill-mode. However, comments in
786 Markdown documents are rare and the most users probably intend
787 for the actual content of the document to be filled. Making
788 this variable buffer-local allows `markdown-mode` to override
789 the default behavior induced when the global variable is non-nil.
791 * `markdown-gfm-additional-languages`, - additional languages to
792 make available, aside from those predefined in
793 `markdown-gfm-recognized-languages`, when inserting GFM code
794 blocks (default: `nil`). Language strings must have be trimmed
795 of whitespace and not contain any curly braces. They may be of
796 arbitrary capitalization, though.
798 * `markdown-gfm-use-electric-backquote` - use
799 `markdown-electric-backquote` for interactive insertion of GFM
800 code blocks when backquote is pressed three times (default: `t`).
802 * `markdown-make-gfm-checkboxes-buttons` - Whether GitHub
803 Flavored Markdown style task lists (checkboxes) should be
804 turned into buttons that can be toggled with mouse-1 or RET. If
805 non-nil (default), then buttons are enabled. This works in
806 `markdown-mode` as well as `gfm-mode`.
808 * `markdown-hide-urls` - Determines whether URL and reference
809 labels are hidden for inline and reference links (default: `nil`).
810 When non-nil, inline links will appear in the buffer as
811 `[link](∞)` instead of
812 `[link](http://perhaps.a/very/long/url/)`. To change the
813 placeholder (composition) character used, set the variable
814 `markdown-url-compose-char`. URL hiding can be toggled
815 interactively using <kbd>C-c C-x C-l</kbd> (`markdown-toggle-url-hiding`)
816 or from the Markdown | Links & Images menu.
818 * `markdown-hide-markup` - Determines whether all possible markup
819 is hidden or otherwise beautified (default: `nil`). The actual
820 buffer text remains unchanged, but the display will be altered.
821 Brackets and URLs for links will be hidden, asterisks and
822 underscores for italic and bold text will be hidden, text
823 bullets for unordered lists will be replaced by Unicode
824 bullets, and so on. Since this includes URLs and reference
825 labels, when non-nil this setting supersedes `markdown-hide-urls`.
826 Markup hiding can be toggled using <kbd>C-c C-x C-m</kbd>
827 (`markdown-toggle-markup-hiding`) or from the Markdown | Show &
830 Unicode bullets are used to replace ASCII list item markers.
831 The list of characters used, in order of list level, can be
832 specified by setting the variable `markdown-list-item-bullets`.
833 The placeholder characters used to replace other markup can
834 be changed by customizing the corresponding variables:
835 `markdown-blockquote-display-char`,
836 `markdown-hr-display-char`, and
837 `markdown-definition-display-char`.
839 * `markdown-fontify-code-blocks-natively` - Whether to fontify
840 code in code blocks using the native major mode. This only
841 works for fenced code blocks where the language is specified
842 where we can automatically determine the appropriate mode to
843 use. The language to mode mapping may be customized by setting
844 the variable `markdown-code-lang-modes`. This can be toggled
845 interactively by pressing <kbd>C-c C-x C-f</kbd>
846 (`markdown-toggle-fontify-code-blocks-natively`).
848 * `markdown-gfm-uppercase-checkbox` - When non-nil, complete GFM
849 task list items with `[X]` instead of `[x]` (default: `nil`).
850 This is useful for compatibility with `org-mode`, which doesn't
851 recognize the lowercase variant.
853 * `markdown-translate-filename-function` - A function to be used to
854 translate filenames in links.
856 Additionally, the faces used for syntax highlighting can be modified to
857 your liking by issuing <kbd>M-x customize-group RET markdown-faces</kbd>
858 or by using the "Markdown Faces" link at the bottom of the mode
859 customization screen.
861 [Marked 2]: https://itunes.apple.com/us/app/marked-2/id890031187?mt=12&uo=4&at=11l5Vs&ct=mm
865 Besides supporting the basic Markdown syntax, Markdown Mode also
866 includes syntax highlighting for `[[Wiki Links]]`. This can be
867 enabled by setting `markdown-enable-wiki-links` to a non-nil value.
868 Wiki links may be followed by pressing <kbd>C-c C-o</kbd> when the point
869 is at a wiki link. Use <kbd>M-p</kbd> and <kbd>M-n</kbd> to quickly jump to the
870 previous and next links (including links of other types).
871 Aliased or piped wiki links of the form `[[link text|PageName]]`
872 are also supported. Since some wikis reverse these components, set
873 `markdown-wiki-link-alias-first` to nil to treat them as
874 `[[PageName|link text]]`. If `markdown-wiki-link-fontify-missing`
875 is also non-nil, Markdown Mode will highlight wiki links with
876 missing target file in a different color. By default, Markdown
877 Mode only searches for target files in the current directory.
878 Search in subdirectories can be enabled by setting
879 `markdown-wiki-link-search-subdirectories` to a non-nil value.
880 Sequential parent directory search (as in [Ikiwiki][]) can be
881 enabled by setting `markdown-wiki-link-search-parent-directories`
884 [Ikiwiki]: https://ikiwiki.info
886 [SmartyPants][] support is possible by customizing `markdown-command`.
887 If you install `SmartyPants.pl` at, say, `/usr/local/bin/smartypants`,
888 then you can set `markdown-command` to `"markdown | smartypants"`.
889 You can do this either by using <kbd>M-x customize-group markdown</kbd>
890 or by placing the following in your `.emacs` file:
893 (setq markdown-command "markdown | smartypants")
896 [SmartyPants]: http://daringfireball.net/projects/smartypants/
898 Syntax highlighting for mathematical expressions written
899 in LaTeX (only expressions denoted by `$..$`, `$$..$$`, or `\[..\]`)
900 can be enabled by setting `markdown-enable-math` to a non-nil value,
901 either via customize or by placing `(setq markdown-enable-math t)`
902 in `.emacs`, and then restarting Emacs or calling
903 `markdown-reload-extensions`.
905 ## GitHub Flavored Markdown (GFM)
907 A [GitHub Flavored Markdown][GFM] mode, `gfm-mode`, is also
908 available. The GitHub implementation differs slightly from
909 standard Markdown in that it supports things like different
910 behavior for underscores inside of words, automatic linking of
911 URLs, strikethrough text, and fenced code blocks with an optional
914 The GFM-specific features above apply to `README.md` files, wiki
915 pages, and other Markdown-formatted files in repositories on
916 GitHub. GitHub also enables [additional features][GFM comments] for
917 writing on the site (for issues, pull requests, messages, etc.)
918 that are further extensions of GFM. These features include task
919 lists (checkboxes), newlines corresponding to hard line breaks,
920 auto-linked references to issues and commits, wiki links, and so
921 on. To make matters more confusing, although task lists are not
922 part of [GFM proper][GFM], [since 2014][] they are rendered (in a
923 read-only fashion) in all Markdown documents in repositories on the
924 site. These additional extensions are supported to varying degrees
925 by `markdown-mode` and `gfm-mode` as described below.
927 * **URL autolinking:** Both `markdown-mode` and `gfm-mode` support
928 highlighting of URLs without angle brackets.
930 * **Multiple underscores in words:** You must enable `gfm-mode` to
931 toggle support for underscores inside of words. In this mode
932 variable names such as `a_test_variable` will not trigger
935 * **Fenced code blocks:** Code blocks quoted with backquotes, with
936 optional programming language keywords, are highlighted in
937 both `markdown-mode` and `gfm-mode`. They can be inserted with
938 <kbd>C-c C-s C</kbd>. If there is an active region, the text in the
939 region will be placed inside the code block. You will be
940 prompted for the name of the language, but may press enter to
941 continue without naming a language.
943 * **Strikethrough:** Strikethrough text is supported in both
944 `markdown-mode` and `gfm-mode`. It can be inserted (and toggled)
945 using <kbd>C-c C-s s</kbd>.
947 * **Task lists:** GFM task lists will be rendered as checkboxes
948 (Emacs buttons) in both `markdown-mode` and `gfm-mode` when
949 `markdown-make-gfm-checkboxes-buttons` is set to a non-nil value
950 (and it is set to t by default). These checkboxes can be
951 toggled by clicking `mouse-1`, pressing <kbd>RET</kbd> over the button,
952 or by pressing <kbd>C-c C-d</kbd> (`markdown-do`) with the point anywhere
953 in the task list item. A normal list item can be turned to a
954 check list item by the same command, or more specifically
955 <kbd>C-c C-s [</kbd> (`markdown-insert-gfm-checkbox`).
957 * **Wiki links:** Generic wiki links are supported in
958 `markdown-mode`, but in `gfm-mode` specifically they will be
959 treated as they are on GitHub: spaces will be replaced by hyphens
960 in filenames and the first letter of the filename will be
961 capitalized. For example, `[[wiki link]]` will map to a file
962 named `Wiki-link` with the same extension as the current file.
963 If a file with this name does not exist in the current directory,
964 the first match in a subdirectory, if any, will be used instead.
966 * **Newlines:** Neither `markdown-mode` nor `gfm-mode` do anything
967 specifically with respect to newline behavior. If you use
968 `gfm-mode` mostly to write text for comments or issues on the
969 GitHub site--where newlines are significant and correspond to
970 hard line breaks--then you may want to enable `visual-line-mode`
971 for line wrapping in buffers. You can do this with a
972 `gfm-mode-hook` as follows:
975 ;; Use visual-line-mode in gfm-mode
976 (defun my-gfm-mode-hook ()
977 (visual-line-mode 1))
978 (add-hook 'gfm-mode-hook 'my-gfm-mode-hook)
981 * **Preview:** GFM-specific preview can be powered by setting
982 `markdown-command` to use [Docter][]. This may also be
983 configured to work with [Marked 2][] for `markdown-open-command`.
985 [GFM]: http://github.github.com/github-flavored-markdown/
986 [GFM comments]: https://help.github.com/articles/writing-on-github/
987 [since 2014]: https://github.com/blog/1825-task-lists-in-all-markdown-documents
988 [Docter]: https://github.com/alampros/Docter
992 markdown-mode has benefited greatly from the efforts of the many
993 volunteers who have sent patches, test cases, bug reports,
994 suggestions, helped with packaging, etc. Thank you for your
995 contributions! See the [contributors graph][contrib] for details.
997 [contrib]: https://github.com/jrblevin/markdown-mode/graphs/contributors
1001 markdown-mode is developed and tested primarily for compatibility
1002 with GNU Emacs 24.3 and later. If you find any bugs in
1003 markdown-mode, please construct a test case or a patch and open a
1004 ticket on the [GitHub issue tracker][issues]. See the
1005 contributing guidelines in `CONTRIBUTING.md` for details on
1006 creating pull requests.
1008 [issues]: https://github.com/jrblevin/markdown-mode/issues
1012 markdown-mode was written and is maintained by Jason Blevins. The
1013 first version was released on May 24, 2007.
1015 * 2007-05-24: [Version 1.1][]
1016 * 2007-05-25: [Version 1.2][]
1017 * 2007-06-05: [Version 1.3][]
1018 * 2007-06-29: [Version 1.4][]
1019 * 2007-10-11: [Version 1.5][]
1020 * 2008-06-04: [Version 1.6][]
1021 * 2009-10-01: [Version 1.7][]
1022 * 2011-08-12: [Version 1.8][]
1023 * 2011-08-15: [Version 1.8.1][]
1024 * 2013-01-25: [Version 1.9][]
1025 * 2013-03-24: [Version 2.0][]
1026 * 2016-01-09: [Version 2.1][]
1027 * 2017-05-26: [Version 2.2][]
1028 * 2017-08-31: [Version 2.3][]
1030 [Version 1.1]: https://jblevins.org/projects/markdown-mode/rev-1-1
1031 [Version 1.2]: https://jblevins.org/projects/markdown-mode/rev-1-2
1032 [Version 1.3]: https://jblevins.org/projects/markdown-mode/rev-1-3
1033 [Version 1.4]: https://jblevins.org/projects/markdown-mode/rev-1-4
1034 [Version 1.5]: https://jblevins.org/projects/markdown-mode/rev-1-5
1035 [Version 1.6]: https://jblevins.org/projects/markdown-mode/rev-1-6
1036 [Version 1.7]: https://jblevins.org/projects/markdown-mode/rev-1-7
1037 [Version 1.8]: https://jblevins.org/projects/markdown-mode/rev-1-8
1038 [Version 1.8.1]: https://jblevins.org/projects/markdown-mode/rev-1-8-1
1039 [Version 1.9]: https://jblevins.org/projects/markdown-mode/rev-1-9
1040 [Version 2.0]: https://jblevins.org/projects/markdown-mode/rev-2-0
1041 [Version 2.1]: https://jblevins.org/projects/markdown-mode/rev-2-1
1042 [Version 2.2]: https://jblevins.org/projects/markdown-mode/rev-2-2
1043 [Version 2.3]: https://jblevins.org/projects/markdown-mode/rev-2-3