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