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