Perform syntax propertization before hooks run
[markdown-mode.git] / README.md
blob5d34b8eede94187e11825323c445d1fb30775a42
1 # Emacs Markdown Mode [![MELPA badge][melpa-badge]][melpa-link] [![MELPA stable badge][melpa-stable-badge]][melpa-stable-link] [![Travis CI Build Status][travis-badge]][travis-link] [![Guide to Markdown Mode for Emacs][leanpub-badge]][leanpub-link]
3   [melpa-link]: https://melpa.org/#/markdown-mode
4   [melpa-stable-link]: https://stable.melpa.org/#/markdown-mode
5   [melpa-badge]: https://melpa.org/packages/markdown-mode-badge.svg
6   [melpa-stable-badge]: https://stable.melpa.org/packages/markdown-mode-badge.svg
7   [travis-link]: https://travis-ci.org/jrblevin/markdown-mode
8   [travis-badge]: https://travis-ci.org/jrblevin/markdown-mode.svg?branch=master
9   [leanpub-link]: https://leanpub.com/markdown-mode
10   [leanpub-badge]: https://img.shields.io/badge/leanpub-guide-orange.svg
12 <!-- This file is autogenerated by webpage.sh from the comments at the top of
13      markdown-mode.el. Make edits there, not here. -->
15 markdown-mode is a major mode for editing [Markdown][]-formatted
16 text.  The latest stable version is markdown-mode 2.3, released on
17 August 31, 2017.  See the [release notes][] for details.
18 markdown-mode is free software, licensed under the GNU GPL,
19 version 3 or later.
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://jblevins.org/projects/markdown-mode/rev-2-3
26 ## Documentation
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">
30 </a>
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>
43 (`describe-mode`).
45  [guide]: https://leanpub.com/markdown-mode
47 ## Installation
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:
64 ```lisp
65 (require 'package)
66 (add-to-list 'package-archives
67              '("melpa-stable" . "https://stable.melpa.org/packages/"))
68 (package-initialize)
69 ```
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 either `.md` or `.markdown`.
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):
82 ```lisp
83 (use-package markdown-mode
84   :ensure t
85   :commands (markdown-mode gfm-mode)
86   :mode (("README\\.md\\'" . gfm-mode)
87          ("\\.md\\'" . markdown-mode)
88          ("\\.markdown\\'" . markdown-mode))
89   :init (setq markdown-command "multimarkdown"))
90 ```
92 [MELPA Stable]: http://stable.melpa.org/
93 [use-package]: https://github.com/jwiegley/use-package
95 **Direct Download**
97 Alternatively you can manually download and install markdown-mode.
98 First, download the [latest stable version][markdown-mode.el] and
99 save the file where Emacs can find it (i.e., a directory in your
100 `load-path`). You can then configure `markdown-mode` and `gfm-mode`
101 to load automatically by adding the following to your init file:
103 ```lisp
104 (autoload 'markdown-mode "markdown-mode"
105    "Major mode for editing Markdown files" t)
106 (add-to-list 'auto-mode-alist '("\\.markdown\\'" . markdown-mode))
107 (add-to-list 'auto-mode-alist '("\\.md\\'" . markdown-mode))
109 (autoload 'gfm-mode "markdown-mode"
110    "Major mode for editing GitHub Flavored Markdown files" t)
111 (add-to-list 'auto-mode-alist '("README\\.md\\'" . gfm-mode))
114 [markdown-mode.el]: https://jblevins.org/projects/markdown-mode/markdown-mode.el
116 **Development Version**
118 To follow or contribute to markdown-mode development, you can
119 browse or clone the Git repository
120 [on GitHub](https://github.com/jrblevin/markdown-mode):
123 git clone https://github.com/jrblevin/markdown-mode.git
126 If you prefer to install and use the development version, which may
127 become unstable at some times, you can either clone the Git
128 repository as above or install markdown-mode from
129 [MELPA](https://melpa.org/#/markdown-mode).
131 If you clone the repository directly, then make sure that Emacs can
132 find it by adding the following line to your startup file:
134 ```lisp
135 (add-to-list 'load-path "/path/to/markdown-mode/repository")
138 **Packaged Installation**
140 markdown-mode is also available in several package managers. You
141 may want to confirm that the package you install contains the
142 latest stable version first (and please notify the package
143 maintainer if not).
145    * Debian Linux: [elpa-markdown-mode][] and [emacs-goodies-el][]
146    * Ubuntu Linux: [elpa-markdown-mode][elpa-ubuntu] and [emacs-goodies-el][emacs-goodies-el-ubuntu]
147    * RedHat and Fedora Linux: [emacs-goodies][]
148    * NetBSD: [textproc/markdown-mode][]
149    * MacPorts: [markdown-mode.el][macports-package] ([pending][macports-ticket])
150    * FreeBSD: [textproc/markdown-mode.el][freebsd-port]
152  [elpa-markdown-mode]: https://packages.debian.org/sid/lisp/elpa-markdown-mode
153  [elpa-ubuntu]: http://packages.ubuntu.com/search?keywords=elpa-markdown-mode
154  [emacs-goodies-el]: http://packages.debian.org/emacs-goodies-el
155  [emacs-goodies-el-ubuntu]: http://packages.ubuntu.com/search?keywords=emacs-goodies-el
156  [emacs-goodies]: https://apps.fedoraproject.org/packages/emacs-goodies
157  [textproc/markdown-mode]: http://pkgsrc.se/textproc/markdown-mode
158  [macports-package]: https://trac.macports.org/browser/trunk/dports/editors/markdown-mode.el/Portfile
159  [macports-ticket]: http://trac.macports.org/ticket/35716
160  [freebsd-port]: http://svnweb.freebsd.org/ports/head/textproc/markdown-mode.el
162 **Dependencies**
164 To enable editing of code blocks in indirect buffers using <kbd>C-c '</kbd>,
165 you will need to install the [`edit-indirect`][ei] package.
167   [ei]: https://github.com/Fanael/edit-indirect/
169 ## Usage
171 Keybindings are grouped by prefixes based on their function.  For
172 example, the commands for styling text are grouped under <kbd>C-c C-s</kbd>
173 and toggle commands begin with <kbd>C-c C-x</kbd>.  The primary commands in
174 each group will are described below.  You can obtain a list of all
175 keybindings by pressing <kbd>C-c C-h</kbd>.  Movement and shifting commands
176 tend to be associated with paired delimiters such as <kbd>M-{</kbd> and
177 <kbd>M-}</kbd> or <kbd>C-c <</kbd> and <kbd>C-c ></kbd>.  Outline navigation keybindings the
178 same as in `org-mode`.  Finally, commands for running Markdown or
179 doing maintenance on an open file are grouped under the <kbd>C-c C-c</kbd>
180 prefix.  The most commonly used commands are described below. You
181 can obtain a list of all keybindings by pressing <kbd>C-c C-h</kbd>.
183   * Links and Images: <kbd>C-c C-l</kbd> and <kbd>C-c C-i</kbd>
185     <kbd>C-c C-l</kbd> (`markdown-insert-link`) is a general command for
186     inserting new link markup or editing existing link markup. This
187     is especially useful when markup or URL hiding is enabled, so
188     that URLs can't easily be edited directly.  This command can be
189     used to insert links of any form: either inline links,
190     reference links, or plain URLs in angle brackets.  The URL or
191     `[reference]` label, link text, and optional title are entered
192     through a series of interactive prompts.  The type of link is
193     determined by which values are provided:
195     *   If both a URL and link text are given, insert an inline link:
196         `[text](url)`.
197     *   If both a `[reference]` label and link text are given, insert
198         a reference link: `[text][reference]`.
199     *   If only link text is given, insert an implicit reference link:
200         `[text][]`.
201     *   If only a URL is given, insert a plain URL link:
202         `<url>`.
204     Similarly, <kbd>C-c C-i</kbd> (`markdown-insert-image`) is a general
205     command for inserting or editing image markup.  As with the link
206     insertion command, through a series interactive prompts you can
207     insert either an inline or reference image:
209     *   If both a URL and alt text are given, insert an inline
210         image: `![alt text](url)`.
211     *   If both a `[reference]` label and alt text are given,
212         insert a reference link: `![alt text][reference]`.
214     If there is an existing link or image at the point, these
215     command will edit the existing markup rather than inserting new
216     markup.  Otherwise, if there is an active region, these commands
217     use the region as either the default URL (if it seems to be a
218     URL) or link text value otherwise.  In that case, the region
219     will be deleted and replaced by the link.
221     Note that these functions can be used to convert links and
222     images from one type to another (inline, reference, or plain
223     URL) by selectively adding or removing properties via the
224     interactive prompts.
226     If a reference label is given that is not yet defined, you
227     will be prompted for the URL and optional title and the
228     reference will be inserted according to the value of
229     `markdown-reference-location`.  If a title is given, it will be
230     added to the end of the reference definition and will be used
231     to populate the title attribute when converted to HTML.
233     Local images associated with image links may be displayed
234     inline in the buffer by pressing <kbd>C-c C-x C-i</kbd>
235     (`markdown-toggle-inline-images`).  This is a toggle command, so
236     pressing this once again will remove inline images.  Large
237     images may be scaled down to fit in the buffer using
238     `markdown-max-image-size`, a cons cell of the form
239     `(max-width . max-height)`.  Resizing requires Emacs to be
240     built with ImageMagick support.
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
259     commands.
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>
305     (counting from 1).
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`.
344     To summarize:
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 n</kbd> renumbers any ordered lists in the buffer that are
363     out of sequence.
365     <kbd>C-c C-c ]</kbd> completes all headings and normalizes all horizontal
366     rules in the buffer.
368   * Following Links: <kbd>C-c C-o</kbd>
370     Press <kbd>C-c C-o</kbd> when the point is on an inline or reference
371     link to open the URL in a browser.  When the point is at a
372     wiki link, open it in another buffer (in the current window,
373     or in the other window with the <kbd>C-u</kbd> prefix).  Use <kbd>M-p</kbd> and
374     <kbd>M-n</kbd> to quickly jump to the previous or next link of any type.
376   * Doing Things: <kbd>C-c C-d</kbd>
378     Use <kbd>C-c C-d</kbd> to do something sensible with the object at the point:
380       - Jumps between reference links and reference definitions.
381         If more than one link uses the same reference label, a
382         window will be shown containing clickable buttons for
383         jumping to each link.  Pressing <kbd>TAB</kbd> or <kbd>S-TAB</kbd> cycles
384         between buttons in this window.
385       - Jumps between footnote markers and footnote text.
386       - Toggles the completion status of GFM task list items
387         (checkboxes).
388       - Re-aligns table columns.
390   * Promotion and Demotion: <kbd>C-c C--</kbd> and <kbd>C-c C-=</kbd>
392     Headings, horizontal rules, and list items can be promoted and
393     demoted, as well as bold and italic text.  For headings,
394     "promotion" means *decreasing* the level (i.e., moving from
395     `<h2>` to `<h1>`) while "demotion" means *increasing* the
396     level.  For horizontal rules, promotion and demotion means
397     moving backward or forward through the list of rule strings in
398     `markdown-hr-strings`.  For bold and italic text, promotion and
399     demotion means changing the markup from underscores to asterisks.
400     Press <kbd>C-c C--</kbd> or <kbd>C-c LEFT</kbd> to promote the element at the point
401     if possible.
403     To remember these commands, note that <kbd>-</kbd> is for decreasing the
404     level (promoting), and <kbd>=</kbd> (on the same key as <kbd>+</kbd>) is for
405     increasing the level (demoting).  Similarly, the left and right
406     arrow keys indicate the direction that the atx heading markup
407     is moving in when promoting or demoting.
409   * Completion: <kbd>C-c C-]</kbd>
411     Complete markup is in normalized form, which means, for
412     example, that the underline portion of a setext header is the
413     same length as the heading text, or that the number of leading
414     and trailing hash marks of an atx header are equal and that
415     there is no extra whitespace in the header text.  <kbd>C-c C-]</kbd>
416     completes the markup at the point, if it is determined to be
417     incomplete.
419   * 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>
421     New list items can be inserted with <kbd>M-RET</kbd> or <kbd>C-c C-j</kbd>.  This
422     command determines the appropriate marker (one of the possible
423     unordered list markers or the next number in sequence for an
424     ordered list) and indentation level by examining nearby list
425     items.  If there is no list before or after the point, start a
426     new list.  As with heading insertion, you may prefix this
427     command by <kbd>C-u</kbd> to decrease the indentation by one level.
428     Prefix this command by <kbd>C-u C-u</kbd> to increase the indentation by
429     one level.
431     Existing list items (and their nested sub-items) can be moved
432     up or down with <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> and indented or
433     outdented with <kbd>C-c RIGHT</kbd> or <kbd>C-c LEFT</kbd>.
435   * Editing Subtrees: <kbd>C-c UP</kbd>, <kbd>C-c DOWN</kbd>, <kbd>C-c LEFT</kbd>, and <kbd>C-c RIGHT</kbd>
437     Entire subtrees of ATX headings can be promoted and demoted
438     with <kbd>C-c LEFT</kbd> and <kbd>C-c RIGHT</kbd>, which are the same keybindings
439     used for promotion and demotion of list items.   If the point is in
440     a list item, the operate on the list item.  Otherwise, they operate
441     on the current heading subtree.  Similarly, subtrees can be
442     moved up and down with <kbd>C-c UP</kbd> and <kbd>C-c DOWN</kbd>.
444     These commands currently do not work properly if there are
445     Setext headings in the affected region.
447     Please note the following "boundary" behavior for promotion and
448     demotion.  Any level-six headings will not be demoted further
449     (i.e., they remain at level six, since Markdown and HTML define
450     only six levels) and any level-one headings will promoted away
451     entirely (i.e., heading markup will be removed, since a
452     level-zero heading is not defined).
454   * Shifting the Region: <kbd>C-c <</kbd> and <kbd>C-c ></kbd>
456     Text in the region can be indented or outdented as a group using
457     <kbd>C-c ></kbd> to indent to the next indentation point (calculated in
458     the current context), and <kbd>C-c <</kbd> to outdent to the previous
459     indentation point.  These keybindings are the same as those for
460     similar commands in `python-mode`.
462   * Killing Elements: <kbd>C-c C-k</kbd>
464     Press <kbd>C-c C-k</kbd> to kill the thing at point and add important
465     text, without markup, to the kill ring.  Possible things to
466     kill include (roughly in order of precedece): inline code,
467     headings, horizonal rules, links (add link text to kill ring),
468     images (add alt text to kill ring), angle URIs, email
469     addresses, bold, italics, reference definitions (add URI to
470     kill ring), footnote markers and text (kill both marker and
471     text, add text to kill ring), and list items.
473   * 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>
475     These keys are used for hierarchical navigation in lists and
476     headings.  When the point is in a list, they move between list
477     items.  Otherwise, they move between headings.  Use <kbd>C-c C-n</kbd> and
478     <kbd>C-c C-p</kbd> to move between the next and previous visible
479     headings or list items of any level.  Similarly, <kbd>C-c C-f</kbd> and
480     <kbd>C-c C-b</kbd> move to the next and previous visible headings or
481     list items at the same level as the one at the point.  Finally,
482     <kbd>C-c C-u</kbd> will move up to the parent heading or list item.
484   * Movement by Markdown paragraph: <kbd>M-{</kbd>, <kbd>M-}</kbd>, and <kbd>M-h</kbd>
486     Paragraphs in `markdown-mode` are regular paragraphs,
487     paragraphs inside blockquotes, individual list items, headings,
488     etc.  These keys are usually bound to `forward-paragraph` and
489     `backward-paragraph`, but the built-in Emacs functions are
490     based on simple regular expressions that fail in Markdown
491     files.  Instead, they are bound to `markdown-forward-paragraph`
492     and `markdown-backward-paragraph`.  To mark a paragraph,
493     you can use <kbd>M-h</kbd> (`markdown-mark-paragraph`).
495   * Movement by Markdown block: <kbd>C-M-{</kbd>, <kbd>C-M-}</kbd>, and <kbd>C-c M-h</kbd>
497     Markdown blocks are regular paragraphs in many cases, but
498     contain many paragraphs in other cases: blocks are considered
499     to be entire lists, entire code blocks, and entire blockquotes.
500     To move backward one block use <kbd>C-M-{</kbd>
501     (`markdown-beginning-block`) and to move forward use <kbd>C-M-}</kbd>
502     (`markdown-end-of-block`).  To mark a block, use <kbd>C-c M-h</kbd>
503     (`markdown-mark-block`).
505   * Movement by Defuns: <kbd>C-M-a</kbd>, <kbd>C-M-e</kbd>, and <kbd>C-M-h</kbd>
507     The usual Emacs commands can be used to move by defuns
508     (top-level major definitions).  In markdown-mode, a defun is a
509     section.  As usual, <kbd>C-M-a</kbd> will move the point to the
510     beginning of the current or preceding defun, <kbd>C-M-e</kbd> will move
511     to the end of the current or following defun, and <kbd>C-M-h</kbd> will
512     put the region around the entire defun.
514   * Table Editing:
516     Markdown Mode includes support for editing tables, which
517     have the following basic format:
519         | Right | Left | Center | Default |
520         |------:|:-----|:------:|---------|
521         |    12 | 12   | 12     | 12      |
522         |   123 | 123  | 123    | 123     |
523         |     1 | 1    | 1      | 1       |
525     The first line contains column headers. The second line
526     contains a separator line between the headers and the content.
527     Each following line is a row in the table.  Columns are always
528     separated by the pipe character.  The colons indicate column
529     alignment.
531     A table is re-aligned automatically each time you press <kbd>TAB</kbd>
532     or <kbd>RET</kbd> inside the table.  <kbd>TAB</kbd> also moves to the next
533     field (<kbd>RET</kbd> to the next row) and creates new table rows at
534     the end of the table or before horizontal separator lines.  The
535     indentation of the table is set by the first line.  Column
536     centering inside Emacs is not supported.
538     Beginning pipe characters are required for proper detection of
539     table borders inside Emacs.  Any line starting with `|-` or `|:`
540     is considered as a horizontal separator line and will be
541     expanded on the next re-align to span the whole table width.  No
542     padding is allowed between the beginning pipe character and
543     header separator symbol.  So, to create the above table, you
544     would only type
546         |Right|Left|Center|Default|
547         |-
549     and then press <kbd>TAB</kbd> to align the table and start filling in
550     cells.
552     Then you can jump with <kbd>TAB</kbd> from one cell to the next or with
553     <kbd>S-TAB</kbd> to the previous one.  <kbd>RET</kbd> will jump to the to the
554     next cell in the same column, and create a new row if there is
555     no such cell or if the next row is beyond a separator line.
557     You can also convert selected region to a table. Basic editing
558     capabilities include inserting, deleting, and moving of columns
559     and rows, and table re-alignment, sorting, transposition:
561       - <kbd>C-c UP</kbd> or <kbd>C-c DOWN</kbd> - Move the current row up or down.
562       - <kbd>C-c LEFT</kbd> or <kbd>C-c RIGHT</kbd> - Move the current column left or right.
563       - <kbd>C-c S-UP</kbd> - Kill the current row.
564       - <kbd>C-c S-DOWN</kbd> - Insert a row above the current row. With a
565         prefix argument, row line is created below the current one.
566       - <kbd>C-c S-LEFT</kbd> - Kill the current column.
567       - <kbd>C-c S-RIGHT</kbd> - Insert a new column to the left of the current one.
568       - <kbd>C-c C-d</kbd> - Re-align the current table (`markdown-do`).
569       - <kbd>C-c C-c ^</kbd> - Sort the rows of a table by a specified column.
570         This command prompts you for the column number and a sort
571         method (alphabetical or numerical, optionally in reverse).
572       - <kbd>C-c C-c |</kbd> - Convert the region to a table.  This function
573         attempts to recognize comma, tab, and space separated data
574         and then splits the data into cells accordingly.
575       - <kbd>C-c C-c t</kbd> - Transpose table at point.
577     The table editing functions try to handle markup hiding
578     correctly when calculating column widths, however, columns
579     containing hidden markup may not always be aligned properly.
581   * Miscellaneous Commands:
583     When the [`edit-indirect`][ei] package is installed, <kbd>C-c '</kbd>
584     (`markdown-edit-code-block`) can be used to edit a code block
585     in an indirect buffer in the native major mode. Press <kbd>C-c C-c</kbd>
586     to commit changes and return or <kbd>C-c C-k</kbd> to cancel.  You can
587     also give a prefix argument to the insertion command, as in
588     <kbd>C-u C-c C-s C</kbd>, to edit the code block in an indirect buffer
589     upon insertion.
591 As noted, many of the commands above behave differently depending
592 on whether Transient Mark mode is enabled or not.  When it makes
593 sense, if Transient Mark mode is on and the region is active, the
594 command applies to the text in the region (e.g., <kbd>C-c C-s b</kbd> makes the
595 region bold).  For users who prefer to work outside of Transient
596 Mark mode, since Emacs 22 it can be enabled temporarily by pressing
597 <kbd>C-SPC C-SPC</kbd>.  When this is not the case, many commands then
598 proceed to look work with the word or line at the point.
600 When applicable, commands that specifically act on the region even
601 outside of Transient Mark mode have the same keybinding as their
602 standard counterpart, but the letter is uppercase.  For example,
603 `markdown-insert-blockquote` is bound to <kbd>C-c C-s q</kbd> and only acts on
604 the region in Transient Mark mode while `markdown-blockquote-region`
605 is bound to <kbd>C-c C-s Q</kbd> and always applies to the region (when nonempty).
607 Note that these region-specific functions are useful in many
608 cases where it may not be obvious.  For example, yanking text from
609 the kill ring sets the mark at the beginning of the yanked text
610 and moves the point to the end.  Therefore, the (inactive) region
611 contains the yanked text.  So, <kbd>C-y</kbd> followed by <kbd>C-c C-s Q</kbd> will
612 yank text and turn it into a blockquote.
614 markdown-mode attempts to be flexible in how it handles
615 indentation.  When you press <kbd>TAB</kbd> repeatedly, the point will cycle
616 through several possible indentation levels corresponding to things
617 you might have in mind when you press <kbd>RET</kbd> at the end of a line or
618 <kbd>TAB</kbd>.  For example, you may want to start a new list item,
619 continue a list item with hanging indentation, indent for a nested
620 pre block, and so on.  Outdenting is handled similarly when backspace
621 is pressed at the beginning of the non-whitespace portion of a line.
623 markdown-mode supports outline-minor-mode as well as org-mode-style
624 visibility cycling for atx- or hash-style headings.  There are two
625 types of visibility cycling: Pressing <kbd>S-TAB</kbd> cycles globally between
626 the table of contents view (headings only), outline view (top-level
627 headings only), and the full document view.  Pressing <kbd>TAB</kbd> while the
628 point is at a heading will cycle through levels of visibility for the
629 subtree: completely folded, visible children, and fully visible.
630 Note that mixing hash and underline style headings will give undesired
631 results.
633 ## Customization
635 Although no configuration is *necessary* there are a few things
636 that can be customized.  The <kbd>M-x customize-mode</kbd> command
637 provides an interface to all of the possible customizations:
639   * `markdown-command` - the command used to run Markdown (default:
640     `markdown`).  This variable may be customized to pass
641     command-line options to your Markdown processor of choice.  It can
642     also be a function; in this case `markdown` will call it with three
643     arguments: the beginning and end of the region to process, and
644     a buffer to write the output to.
646   * `markdown-command-needs-filename` - set to `t` if
647     `markdown-command` does not accept standard input (default:
648     `nil`).  When `nil`, `markdown-mode` will pass the Markdown
649     content to `markdown-command` using standard input (`stdin`).
650     When set to `t`, `markdown-mode` will pass the name of the file
651     as the final command-line argument to `markdown-command`.  Note
652     that in the latter case, you will only be able to run
653     `markdown-command` from buffers which are visiting a file.  If
654     `markdown-command` is a function, `markdown-command-needs-filename`
655     is ignored.
657   * `markdown-open-command` - the command used for calling a standalone
658     Markdown previewer which is capable of opening Markdown source files
659     directly (default: `nil`).  This command will be called
660     with a single argument, the filename of the current buffer.
661     A representative program is the Mac app [Marked 2][], a
662     live-updating Markdown previewer which can be [called from a
663     simple shell script](https://jblevins.org/log/marked-2-command).
664     This variable can also be a function; in this case `markdown-open`
665     will call it without arguments to preview the current buffer.
667   * `markdown-hr-strings` - list of strings to use when inserting
668     horizontal rules.  Different strings will not be distinguished
669     when converted to HTML--they will all be converted to
670     `<hr/>`--but they may add visual distinction and style to plain
671     text documents.  To maintain some notion of promotion and
672     demotion, keep these sorted from largest to smallest.
674   * `markdown-bold-underscore` - set to a non-nil value to use two
675     underscores when inserting bold text instead of two asterisks
676     (default: `nil`).
678   * `markdown-italic-underscore` - set to a non-nil value to use
679     underscores when inserting italic text instead of asterisks
680     (default: `nil`).
682   * `markdown-asymmetric-header` - set to a non-nil value to use
683     asymmetric header styling, placing header characters only on
684     the left of headers (default: `nil`).
686   * `markdown-header-scaling` - set to a non-nil value to use
687     a variable-pitch font for headings where the size corresponds
688     to the level of the heading (default: `nil`).
690   * `markdown-header-scaling-values` - list of scaling values,
691     relative to baseline, for headers of levels one through six,
692     used when `markdown-header-scaling` is non-nil
693     (default: `(2.0 1.7 1.4 1.1 1.0 1.0)`).
695   * `markdown-marginalize-headers` - put opening atx header markup
696     in the left margin when non-nil (default: `nil`).
698   * `markdown-marginalize-headers-margin-width` - width of margin
699     used for marginalized headers (default: 6).
701   * `markdown-list-indent-width` - depth of indentation for lists
702     when inserting, promoting, and demoting list items (default: 4).
704   * `markdown-indent-function` - the function to use for automatic
705     indentation (default: `markdown-indent-line`).
707   * `markdown-indent-on-enter` - Set to a non-nil value to
708     automatically indent new lines when <kbd>RET</kbd> is pressed.
709     Set to `indent-and-new-item` to additionally continue lists
710     when <kbd>RET</kbd> is pressed (default: `t`).
712   * `markdown-enable-wiki-links` - syntax highlighting for wiki
713     links (default: `nil`).  Set this to a non-nil value to turn on
714     wiki link support by default.  Wiki link support can be toggled
715     later using the function `markdown-toggle-wiki-links`."
717   * `markdown-wiki-link-alias-first` - set to a non-nil value to
718     treat aliased wiki links like `[[link text|PageName]]`
719     (default: `t`).  When set to nil, they will be treated as
720     `[[PageName|link text]]`.
722   * `markdown-uri-types` - a list of protocol schemes (e.g., "http")
723     for URIs that `markdown-mode` should highlight.
725   * `markdown-enable-math` - font lock for inline and display LaTeX
726     math expressions (default: `nil`).  Set this to `t` to turn on
727     math support by default.  Math support can be toggled
728     interactively later using <kbd>C-c C-x C-e</kbd>
729     (`markdown-toggle-math`).
731   * `markdown-enable-html` - font lock for HTML tags and attributes
732     (default: `t`).
734   * `markdown-css-paths` - CSS files to link to in XHTML output
735     (default: `nil`).
737   * `markdown-content-type` - when set to a nonempty string, an
738     `http-equiv` attribute will be included in the XHTML `<head>`
739     block (default: `""`).  If needed, the suggested values are
740     `application/xhtml+xml` or `text/html`.  See also:
741     `markdown-coding-system`.
743   * `markdown-coding-system` - used for specifying the character
744     set identifier in the `http-equiv` attribute when included
745     (default: `nil`).  See `markdown-content-type`, which must
746     be set before this variable has any effect.  When set to `nil`,
747     `buffer-file-coding-system` will be used to automatically
748     determine the coding system string (falling back to
749     `iso-8859-1` when unavailable).  Common settings are `utf-8`
750     and `iso-latin-1`.
752   * `markdown-xhtml-header-content` - additional content to include
753     in the XHTML `<head>` block (default: `""`).
755   * `markdown-xhtml-standalone-regexp` - a regular expression which
756     `markdown-mode` uses to determine whether the output of
757     `markdown-command` is a standalone XHTML document or an XHTML
758     fragment (default: `"^\\(<\\?xml\\|<!DOCTYPE\\|<html\\)"`).  If
759     this regular expression not matched in the first five lines of
760     output, `markdown-mode` assumes the output is a fragment and
761     adds a header and footer.
763   * `markdown-link-space-sub-char` - a character to replace spaces
764     when mapping wiki links to filenames (default: `"_"`).
765     For example, use an underscore for compatibility with the
766     Python Markdown WikiLinks extension.  In `gfm-mode`, this is
767     set to `"-"` to conform with GitHub wiki links.
769   * `markdown-reference-location` - where to insert reference
770     definitions (default: `header`).  The possible locations are
771     the end of the document (`end`), after the current block
772     (`immediately`), the end of the current subtree (`subtree`),
773     or before the next header (`header`).
775   * `markdown-footnote-location` - where to insert footnote text
776     (default: `end`).  The set of location options is the same as
777     for `markdown-reference-location`.
779   * `markdown-nested-imenu-heading-index` - Use nested imenu
780     heading instead of a flat index (default: `t`).  A nested
781     index may provide more natural browsing from the menu, but a
782     flat list may allow for faster keyboard navigation via tab
783     completion.
785   * `comment-auto-fill-only-comments` - variable is made
786     buffer-local and set to `nil` by default.  In programming
787     language modes, when this variable is non-nil, only comments
788     will be filled by auto-fill-mode.  However, comments in
789     Markdown documents are rare and the most users probably intend
790     for the actual content of the document to be filled.  Making
791     this variable buffer-local allows `markdown-mode` to override
792     the default behavior induced when the global variable is non-nil.
794   * `markdown-gfm-additional-languages`, - additional languages to
795     make available, aside from those predefined in
796     `markdown-gfm-recognized-languages`, when inserting GFM code
797     blocks (default: `nil`). Language strings must have be trimmed
798     of whitespace and not contain any curly braces. They may be of
799     arbitrary capitalization, though.
801   * `markdown-gfm-use-electric-backquote` - use
802     `markdown-electric-backquote` for interactive insertion of GFM
803     code blocks when backquote is pressed three times (default: `t`).
805   * `markdown-make-gfm-checkboxes-buttons` - Whether GitHub
806     Flavored Markdown style task lists (checkboxes) should be
807     turned into buttons that can be toggled with mouse-1 or RET. If
808     non-nil (default), then buttons are enabled.  This works in
809     `markdown-mode` as well as `gfm-mode`.
811   * `markdown-hide-urls` - Determines whether URL and reference
812     labels are hidden for inline and reference links (default: `nil`).
813     When non-nil, inline links will appear in the buffer as
814     `[link](∞)` instead of
815     `[link](http://perhaps.a/very/long/url/)`.  To change the
816     placeholder (composition) character used, set the variable
817     `markdown-url-compose-char`.  URL hiding can be toggled
818     interactively using <kbd>C-c C-x C-l</kbd> (`markdown-toggle-url-hiding`)
819     or from the Markdown | Links & Images menu.
821   * `markdown-hide-markup` - Determines whether all possible markup
822     is hidden or otherwise beautified (default: `nil`).   The actual
823     buffer text remains unchanged, but the display will be altered.
824     Brackets and URLs for links will be hidden, asterisks and
825     underscores for italic and bold text will be hidden, text
826     bullets for unordered lists will be replaced by Unicode
827     bullets, and so on.  Since this includes URLs and reference
828     labels, when non-nil this setting supersedes `markdown-hide-urls`.
829     Markup hiding can be toggled using <kbd>C-c C-x C-m</kbd>
830     (`markdown-toggle-markup-hiding`) or from the Markdown | Show &
831     Hide menu.
833     Unicode bullets are used to replace ASCII list item markers.
834     The list of characters used, in order of list level, can be
835     specified by setting the variable `markdown-list-item-bullets`.
836     The placeholder characters used to replace other markup can
837     be changed by customizing the corresponding variables:
838     `markdown-blockquote-display-char`,
839     `markdown-hr-display-char`, and
840     `markdown-definition-display-char`.
842   * `markdown-fontify-code-blocks-natively` - Whether to fontify
843     code in code blocks using the native major mode.  This only
844     works for fenced code blocks where the language is specified
845     where we can automatically determine the appropriate mode to
846     use.  The language to mode mapping may be customized by setting
847     the variable `markdown-code-lang-modes`.  This can be toggled
848     interactively by pressing <kbd>C-c C-x C-f</kbd>
849     (`markdown-toggle-fontify-code-blocks-natively`).
851   * `markdown-gfm-uppercase-checkbox` - When non-nil, complete GFM
852     task list items with `[X]` instead of `[x]` (default: `nil`).
853     This is useful for compatibility with `org-mode`, which doesn't
854     recognize the lowercase variant.
856   * `markdown-translate-filename-function` - A function to be used to
857     translate filenames in links.
859 Additionally, the faces used for syntax highlighting can be modified to
860 your liking by issuing <kbd>M-x customize-group RET markdown-faces</kbd>
861 or by using the "Markdown Faces" link at the bottom of the mode
862 customization screen.
864 [Marked 2]: https://itunes.apple.com/us/app/marked-2/id890031187?mt=12&uo=4&at=11l5Vs&ct=mm
866 ## Extensions
868 Besides supporting the basic Markdown syntax, Markdown Mode also
869 includes syntax highlighting for `[[Wiki Links]]`.  This can be
870 enabled by setting `markdown-enable-wiki-links` to a non-nil value.
871 Wiki links may be followed by pressing <kbd>C-c C-o</kbd> when the point
872 is at a wiki link.  Use <kbd>M-p</kbd> and <kbd>M-n</kbd> to quickly jump to the
873 previous and next links (including links of other types).
874 Aliased or piped wiki links of the form `[[link text|PageName]]`
875 are also supported.  Since some wikis reverse these components, set
876 `markdown-wiki-link-alias-first` to nil to treat them as
877 `[[PageName|link text]]`.  If `markdown-wiki-link-fontify-missing`
878 is also non-nil, Markdown Mode will highlight wiki links with
879 missing target file in a different color.  By default, Markdown
880 Mode only searches for target files in the current directory.
881 Search in subdirectories can be enabled by setting
882 `markdown-wiki-link-search-subdirectories` to a non-nil value.
883 Sequential parent directory search (as in [Ikiwiki][]) can be
884 enabled by setting `markdown-wiki-link-search-parent-directories`
885 to a non-nil value.
887 [Ikiwiki]: https://ikiwiki.info
889 [SmartyPants][] support is possible by customizing `markdown-command`.
890 If you install `SmartyPants.pl` at, say, `/usr/local/bin/smartypants`,
891 then you can set `markdown-command` to `"markdown | smartypants"`.
892 You can do this either by using <kbd>M-x customize-group markdown</kbd>
893 or by placing the following in your `.emacs` file:
895 ```lisp
896 (setq markdown-command "markdown | smartypants")
899 [SmartyPants]: http://daringfireball.net/projects/smartypants/
901 Syntax highlighting for mathematical expressions written
902 in LaTeX (only expressions denoted by `$..$`, `$$..$$`, or `\[..\]`)
903 can be enabled by setting `markdown-enable-math` to a non-nil value,
904 either via customize or by placing `(setq markdown-enable-math t)`
905 in `.emacs`, and then restarting Emacs or calling
906 `markdown-reload-extensions`.
908 ## GitHub Flavored Markdown (GFM)
910 A [GitHub Flavored Markdown][GFM] mode, `gfm-mode`, is also
911 available.  The GitHub implementation differs slightly from
912 standard Markdown in that it supports things like different
913 behavior for underscores inside of words, automatic linking of
914 URLs, strikethrough text, and fenced code blocks with an optional
915 language keyword.
917 The GFM-specific features above apply to `README.md` files, wiki
918 pages, and other Markdown-formatted files in repositories on
919 GitHub.  GitHub also enables [additional features][GFM comments] for
920 writing on the site (for issues, pull requests, messages, etc.)
921 that are further extensions of GFM.  These features include task
922 lists (checkboxes), newlines corresponding to hard line breaks,
923 auto-linked references to issues and commits, wiki links, and so
924 on.  To make matters more confusing, although task lists are not
925 part of [GFM proper][GFM], [since 2014][] they are rendered (in a
926 read-only fashion) in all Markdown documents in repositories on the
927 site.  These additional extensions are supported to varying degrees
928 by `markdown-mode` and `gfm-mode` as described below.
930 * **URL autolinking:** Both `markdown-mode` and `gfm-mode` support
931   highlighting of URLs without angle brackets.
933 * **Multiple underscores in words:** You must enable `gfm-mode` to
934   toggle support for underscores inside of words. In this mode
935   variable names such as `a_test_variable` will not trigger
936   emphasis (italics).
938 * **Fenced code blocks:** Code blocks quoted with backquotes, with
939   optional programming language keywords, are highlighted in
940   both `markdown-mode` and `gfm-mode`.  They can be inserted with
941   <kbd>C-c C-s C</kbd>.  If there is an active region, the text in the
942   region will be placed inside the code block.  You will be
943   prompted for the name of the language, but may press enter to
944   continue without naming a language.
946 * **Strikethrough:** Strikethrough text is supported in both
947   `markdown-mode` and `gfm-mode`.  It can be inserted (and toggled)
948   using <kbd>C-c C-s s</kbd>.
950 * **Task lists:** GFM task lists will be rendered as checkboxes
951   (Emacs buttons) in both `markdown-mode` and `gfm-mode` when
952   `markdown-make-gfm-checkboxes-buttons` is set to a non-nil value
953   (and it is set to t by default).  These checkboxes can be
954   toggled by clicking `mouse-1`, pressing <kbd>RET</kbd> over the button,
955   or by pressing <kbd>C-c C-d</kbd> (`markdown-do`) with the point anywhere
956   in the task list item.  A normal list item can be turned to a
957   check list item by the same command, or more specifically
958   <kbd>C-c C-s [</kbd> (`markdown-insert-gfm-checkbox`).
960 * **Wiki links:** Generic wiki links are supported in
961   `markdown-mode`, but in `gfm-mode` specifically they will be
962   treated as they are on GitHub: spaces will be replaced by hyphens
963   in filenames and the first letter of the filename will be
964   capitalized.  For example, `[[wiki link]]` will map to a file
965   named `Wiki-link` with the same extension as the current file.
966   If a file with this name does not exist in the current directory,
967   the first match in a subdirectory, if any, will be used instead.
969 * **Newlines:** Neither `markdown-mode` nor `gfm-mode` do anything
970   specifically with respect to newline behavior.  If you use
971   `gfm-mode` mostly to write text for comments or issues on the
972   GitHub site--where newlines are significant and correspond to
973   hard line breaks--then you may want to enable `visual-line-mode`
974   for line wrapping in buffers.  You can do this with a
975   `gfm-mode-hook` as follows:
977     ```lisp
978     ;; Use visual-line-mode in gfm-mode
979     (defun my-gfm-mode-hook ()
980       (visual-line-mode 1))
981     (add-hook 'gfm-mode-hook 'my-gfm-mode-hook)
982     ```
984 * **Preview:** GFM-specific preview can be powered by setting
985   `markdown-command` to use [Docter][].  This may also be
986   configured to work with [Marked 2][] for `markdown-open-command`.
988 [GFM]: http://github.github.com/github-flavored-markdown/
989 [GFM comments]: https://help.github.com/articles/writing-on-github/
990 [since 2014]: https://github.com/blog/1825-task-lists-in-all-markdown-documents
991 [Docter]: https://github.com/alampros/Docter
993 ## Acknowledgments
995 markdown-mode has benefited greatly from the efforts of the many
996 volunteers who have sent patches, test cases, bug reports,
997 suggestions, helped with packaging, etc.  Thank you for your
998 contributions!  See the [contributors graph][contrib] for details.
1000  [contrib]: https://github.com/jrblevin/markdown-mode/graphs/contributors
1002 ## Bugs
1004 markdown-mode is developed and tested primarily for compatibility
1005 with GNU Emacs 24.3 and later.  If you find any bugs in
1006 markdown-mode, please construct a test case or a patch and open a
1007 ticket on the [GitHub issue tracker][issues].  See the
1008 contributing guidelines in `CONTRIBUTING.md` for details on
1009 creating pull requests.
1011  [issues]: https://github.com/jrblevin/markdown-mode/issues
1013 ## History
1015 markdown-mode was written and is maintained by Jason Blevins.  The
1016 first version was released on May 24, 2007.
1018   * 2007-05-24: [Version 1.1][]
1019   * 2007-05-25: [Version 1.2][]
1020   * 2007-06-05: [Version 1.3][]
1021   * 2007-06-29: [Version 1.4][]
1022   * 2007-10-11: [Version 1.5][]
1023   * 2008-06-04: [Version 1.6][]
1024   * 2009-10-01: [Version 1.7][]
1025   * 2011-08-12: [Version 1.8][]
1026   * 2011-08-15: [Version 1.8.1][]
1027   * 2013-01-25: [Version 1.9][]
1028   * 2013-03-24: [Version 2.0][]
1029   * 2016-01-09: [Version 2.1][]
1030   * 2017-05-26: [Version 2.2][]
1031   * 2017-08-31: [Version 2.3][]
1033 [Version 1.1]: https://jblevins.org/projects/markdown-mode/rev-1-1
1034 [Version 1.2]: https://jblevins.org/projects/markdown-mode/rev-1-2
1035 [Version 1.3]: https://jblevins.org/projects/markdown-mode/rev-1-3
1036 [Version 1.4]: https://jblevins.org/projects/markdown-mode/rev-1-4
1037 [Version 1.5]: https://jblevins.org/projects/markdown-mode/rev-1-5
1038 [Version 1.6]: https://jblevins.org/projects/markdown-mode/rev-1-6
1039 [Version 1.7]: https://jblevins.org/projects/markdown-mode/rev-1-7
1040 [Version 1.8]: https://jblevins.org/projects/markdown-mode/rev-1-8
1041 [Version 1.8.1]: https://jblevins.org/projects/markdown-mode/rev-1-8-1
1042 [Version 1.9]: https://jblevins.org/projects/markdown-mode/rev-1-9
1043 [Version 2.0]: https://jblevins.org/projects/markdown-mode/rev-2-0
1044 [Version 2.1]: https://jblevins.org/projects/markdown-mode/rev-2-1
1045 [Version 2.2]: https://jblevins.org/projects/markdown-mode/rev-2-2
1046 [Version 2.3]: https://jblevins.org/projects/markdown-mode/rev-2-3