Font lock for HTML entities
[markdown-mode.git] / CHANGES.md
blobe02b28f916ceeee510df9ab7f498d68a620d529c
1 # Markdown Mode 2.4
3 *Under development*
5 *   **Breaking changes:**
7 *   New features:
9     -   GFM task list item (checkbox) insertion with `C-c C-s [`, or
10         as a final fallback for `markdown-do` (`C-c C-d`).  Thanks to
11         Akinori Musha for a patch.  ([GH-229][])
12     -   Optionally move leading atx heading markup to the left margin
13         when `markdown-marginalize-headers` is non-`nil`.  Thanks to
14         Alexis Gallagher for a patch.  ([GH-272][], [GH-274][])
15     -   Added pipe table editing features.  Thanks to Dmitry Safronov
16         for a patch.  ([GH-171][], [GH-266][])
17     -   Font lock for HTML entities, with a new face
18         `markdown-html-entity-face`.
20 *   Improvements:
22     -   Insert references before local variables.  Thanks to Philipp
23         Stephani for a patch.  ([GH-216][], [GH-262][])
24     -   Allow `markdown-command` and `markdown-open-command` to be
25         functions.  ([GH-255][], [GH-263][])
26     -   Save the buffer before running `markdown-open-command` and run
27         `markdown-open-command` asynchronously.  Thanks to Dmitry
28         Safronov for a patch.  ([GH-248][])
29     -   New user option `markdown-translate-filename-function` to translate
30         filenames when following file links.  ([GH-268][], [GH-277][])
31     -   Support double-backslash math delimiters.  ([GH-270][])
32     -   New user option `markdown-export-kill-buffer` to kill or preserve
33         HTML export output buffer.  ([GH-224][])
34     -   Add `markdown-edit-code-block-default-mode` to specify default
35         mode for indirect editing of code blocks.  ([GH-251][])
36     -   Insert-and-indirect-edit GFM code blocks simultaneously by
37         giving a prefix argument to `C-c C-s C`.  ([GH-251][])
38     -   Improve package load time by deferring calls to
39         `char-displayable-p`.  ([GH-264][])
41 *   Bug fixes:
43     -   Remove GFM checkbox overlays when switching major modes.
44         ([GH-238][], [GH-257][])
45     -   Don't test the value of the `composition` property to avoid
46         failing tests.  ([GH-246][], [GH-258][])
47     -   Fix types for `markdown-open-command`, `markdown-uri-types`,
48         and `markdown-hr-strings` defcustoms.  ([GH-254][], [GH-259][])
49     -   Don't insert trailing whitespace when inserting a blockquote.
50         ([GH-227][], [GH-260][])
51     -   Make wiki link test work even when `/tmp` contains an
52         inaccessible subdirectory.  ([GH-261][])
53     -   Fix `markdown-inline-code-face`'s `:inherit` attribute.
54         ([GH-252][])
55     -   Fix type of customizable `markdown-css-paths` variable.
56         ([GH-276][])
57     -   Don't set `markdown-code-face` background color at package
58         load time.  ([GH-273][])
59     -   Don't clobber user specified font-lock keywords when toggling
60         features.  ([GH-222][])
61     -   Fix font-lock for inline code inside italics and bold.
62         ([GH-275][])
64   [gh-171]: https://github.com/jrblevin/markdown-mode/issues/171
65   [gh-216]: https://github.com/jrblevin/markdown-mode/issues/216
66   [gh-222]: https://github.com/jrblevin/markdown-mode/issues/222
67   [gh-224]: https://github.com/jrblevin/markdown-mode/issues/224
68   [gh-227]: https://github.com/jrblevin/markdown-mode/issues/227
69   [gh-229]: https://github.com/jrblevin/markdown-mode/pull/229
70   [gh-238]: https://github.com/jrblevin/markdown-mode/issues/238
71   [gh-246]: https://github.com/jrblevin/markdown-mode/issues/246
72   [gh-248]: https://github.com/jrblevin/markdown-mode/issues/248
73   [gh-251]: https://github.com/jrblevin/markdown-mode/issues/251
74   [gh-252]: https://github.com/jrblevin/markdown-mode/pull/252
75   [gh-254]: https://github.com/jrblevin/markdown-mode/issues/254
76   [gh-255]: https://github.com/jrblevin/markdown-mode/issues/255
77   [gh-257]: https://github.com/jrblevin/markdown-mode/pull/257
78   [gh-258]: https://github.com/jrblevin/markdown-mode/pull/258
79   [gh-259]: https://github.com/jrblevin/markdown-mode/pull/259
80   [gh-260]: https://github.com/jrblevin/markdown-mode/pull/260
81   [gh-261]: https://github.com/jrblevin/markdown-mode/pull/261
82   [gh-262]: https://github.com/jrblevin/markdown-mode/pull/262
83   [gh-263]: https://github.com/jrblevin/markdown-mode/pull/263
84   [gh-264]: https://github.com/jrblevin/markdown-mode/pull/264
85   [gh-266]: https://github.com/jrblevin/markdown-mode/issues/266
86   [gh-268]: https://github.com/jrblevin/markdown-mode/issues/268
87   [gh-270]: https://github.com/jrblevin/markdown-mode/issues/270
88   [gh-272]: https://github.com/jrblevin/markdown-mode/issues/272
89   [gh-273]: https://github.com/jrblevin/markdown-mode/issues/273
90   [gh-274]: https://github.com/jrblevin/markdown-mode/pull/274
91   [gh-275]: https://github.com/jrblevin/markdown-mode/issues/275
92   [gh-276]: https://github.com/jrblevin/markdown-mode/issues/276
93   [gh-277]: https://github.com/jrblevin/markdown-mode/pull/277
95 # Markdown Mode 2.3
97 *August 31, 2017*
99 *   **Breaking changes:**
101     -   `markdown-mode` now requires Emacs 24.3 or later.
102     -   Markup insertion and replacement keybindings under <kbd>C-c
103         C-s</kbd> (_s_ for style) have been revised to make them
104         easier to remember.  Now, when the prefix <kbd>C-c C-s</kbd>
105         is pressed, a short minibuffer help prompt is presented as a
106         reminder of a few of the most frequently used keys.  The major
107         changes are that bold is now inserted with <kbd>b</kbd>
108         (previously <kbd>s</kbd>) and italic is now <kbd>i</kbd>
109         (previously <kbd>e</kbd>).  As a result, blockquote is now
110         <kbd>q</kbd> (previously <kbd>b</kbd>) and strikethrough
111         markup is inserted with <kbd>s</kbd> (previously
112         <kbd>d</kbd>).  Press <kbd>C-c C-s C-h</kbd> for a complete
113         list of markup insertion keybindings.  Heading insertion
114         commands are also now under <kbd>C-c C-s</kbd>.
115     -   Link insertion and editing has been consolidated into one
116         command, `markdown-insert-link`, bound to <kbd>C-c C-l</kbd>.
117         As such, the previous separate link insertion keybindings have
118         been removed: <kbd>C-c C-a l</kbd>, <kbd>C-c C-a L</kbd>,
119         <kbd>C-c C-a r</kbd>, and <kbd>C-c C-a u</kbd>.
120     -   Image insertion and editing has been consolidated into one
121         command, `markdown-insert-image`, bound to <kbd>C-c C-i</kbd>.
122         As such, the previous separate image insertion keybindings have
123         been removed: <kbd>C-c C-i i</kbd> and <kbd>C-c C-i I</kbd>.
124     -   Footnote and wiki link insertion have been moved to the
125         markup insertion prefix, as <kbd>C-c C-s f</kbd> and
126         <kbd>C-c C-s w</kbd>.
127     -   The list and outline editing commands have been removed from
128         the top-level positions (previously <kbd>M-LEFT</kbd>,
129         <kbd>M-RIGHT</kbd>, <kbd>M-UP</kbd>, <kbd>M-DOWN</kbd>)
130         and moved to major mode keybindings under <kbd>C-c</kbd> to
131         <kbd>C-c LEFT</kbd>, <kbd>C-c RIGHT</kbd>,
132         <kbd>C-c UP</kbd>, and <kbd>C-c DOWN</kbd>, respectively.
133         ([GH-164][])
134     -   The list and outline editing commands have also been unified
135         so that they all operate on entire subtrees of list items and
136         subtrees of atx headings, symmetrically.  Previously there were
137         separate commands for editing heading subtrees, but promoting
138         a single section is easy enough by directly inserting or
139         removing a hash mark or using the markup replacement commands.
140     -   Jumping between references and reference definitions via
141         `markdown-jump`, previously bound to <kbd>C-c C-l</kbd>, has
142         been moved to <kbd>C-c C-d</kbd> and rebranded as
143         `markdown-do`, which attempts to do something sensible with
144         the object at the point.
145     -   Rename internal `markdown-link-link` to `markdown-link-url`
146         for clarity.
147     -   The old inline image toggling command <kbd>C-c C-i C-t</kbd>
148         has been removed and replaced <kbd>C-c C-x C-i</kbd> in order
149         to allow for the new interactive image insertion command at
150         <kbd>C-c C-i</kbd>.  Toggling keybindings are currently being
151         grouped under <kbd>C-c C-x</kbd>.
152     -   `markdown-blockquote-face` is now applied to the entire
153         blockquote, including the leading `>`, so it can be used to
154         apply a background if desired.
155     -   In `markdown-regex-header`, groups 4 and 6 now include
156         whitespace surrounding hash marks in atx headings.
157     -   Font lock for `~~strikethrough~~` is now supported in
158         `markdown-mode` in addition to `gfm-mode`.
159     -   Introduced a new face for horizontal rules: `markdown-hr-face`.
160         Previously, `markdown-header-delimiter-face` was used.
161     -   Markdown Mode is now distributed under the GNU GPL version 3
162         or later.
163     -   Rename `markdown-fill-forward-paragraph-function` to
164         `markdown-fill-forward-paragraph`.
165     -   Rename `markdown-footnote-face` to `markdown-footnote-marker-face`.
166     -   Functions `markdown-insert-inline-link-dwim` and
167         `markdown-insert-reference-link-dwim` have been combined and
168         replaced with `markdown-insert-link`.
169     -   Functions `markdown-exdent-region` and `markdown-exdent-or-delete`
170         are now named `markdown-outdent-region` and
171         `markdown-outdent-or-delete`, respectively.
172     -   The non-interactive image insertion commands have been
173         refactored to mirror the corresponding link insertion
174         commands.  `markdown-insert-image` (for inline images) has
175         been renamed `markdown-insert-inline-image` and it now takes
176         three arguments (previously one optional argument).
177         `markdown-insert-reference-image` now takes four arguments
178         (previously none).
180 *   New features:
182     -   Markup hiding: Add a custom variable `markdown-hide-markup`,
183         which determines whether to hide or otherwise beautify
184         Markdown markup.  For example, for inline links the brackets,
185         URL, and title will be hidden and only the (clickable) link
186         text will remain.  The URL can be seen by hovering with the
187         mouse pointer and edited by deleting one of the invisible
188         brackets or parentheses.  This can be toggled interactively
189         using <kbd>C-c C-x C-m</kbd> (`markdown-toggle-markup-hiding`).
190         This setting supersedes URL hiding (below).  ([GH-130][])
191     -   Unicode bullets are used to replace ASCII list item markers
192         for unordered lists when markup hiding is enabled.  The list
193         of characters used, in order of list level, can be specified
194         by setting the variable `markdown-list-item-bullets`.
195         ([GH-130][])
196     -   When markup hiding is enabled, the characters used for
197         replacing certain markup can be changed by customizing the
198         corresponding variables:
199         `markdown-blockquote-display-char`,
200         `markdown-hr-display-char`, and
201         `markdown-definition-display-char`.
202     -   URL and reference label hiding: URLs for inline links and
203         labels for reference links can now be hidden if desired.  This is
204         configurable via `markdown-hide-urls`.  URLs will appear as
205         `[link](∞)` instead of
206         `[link](http://perhaps.a/very/long/url/)`.  To change the
207         placeholder character used, set `markdown-url-compose-char`.
208         This feature can be toggled using <kbd>C-c C-x C-l</kbd>
209         (`markdown-toggle-url-hiding`).  If full markup hiding (above)
210         is enabled, then URL hiding has no additional effect.
211     -   Native code block font-lock: Add a custom variable
212         `markdown-fontify-code-blocks-natively`, which determines
213         whether to fontify code in code blocks using the native major
214         mode.  This only works for fenced code blocks where the
215         language is specified where we can automatically determine the
216         appropriate mode to use.  The language to mode mapping may be
217         customized by setting the variable `markdown-code-lang-modes`.
218         ([GH-123][], [GH-185][])
219     -   When the [`edit-indirect`](https://github.com/Fanael/edit-indirect/)
220         package is installed, <kbd>C-c '</kbd> (`markdown-edit-code-block`)
221         can be used to edit a code block in an indirect buffer in the native
222         major mode.  Press <kbd>C-c C-c</kbd> to commit changes and return
223         or <kbd>C-c C-k</kbd> to cancel.
224     -   Add command <kbd>C-c C-x C-f</kbd> for toggling native font lock
225         for code blocks (`markdown-toggle-fontify-code-blocks-natively`).
226     -   Add "page" movement, marking, and narrowing commands, where a
227         "page" in Markdown is defined to be a top-level subtree:
228         `markdown-forward-page` (<kbd>C-x ]</kbd>),
229         `markdown-backward-page` (<kbd>C-x [</kbd>),
230         `markdown-mark-page` (<kbd>C-x C-p</kbd>), and
231         `markdown-narrow-to-page` (<kbd>C-x n p</kbd>).  ([GH-191][])
232     -   Add subtree marking and narrowing functions:
233         `markdown-mark-subtree` (<kbd>C-c C-M-h</kbd>) and
234         `markdown-narrow-to-subtree` (<kbd>C-x n s</kbd>).
235         ([GH-191][])
236     -   Add syntax-aware Markdown paragraph movement commands:
237         <kbd>M-{</kbd> (`markdown-backward-paragraph`) and
238         <kbd>M-}</kbd> (`markdown-forward-paragraph`).  To mark a
239         paragraph, use <kbd>M-h</kbd> (`markdown-mark-paragraph`).
240         These move at a more granular level than the block movement
241         commands.  ([GH-191][])
242     -   The previous block movement and marking commands are now at
243         <kbd>C-M-{</kbd>, <kbd>C-M-}</kbd>, and <kbd>C-c M-h</kbd>.
244         In terms of lists, paragraph movement commands now stop at
245         each list item while block commands move over entire lists.
246         ([GH-191][])
247     -   Add `subtree` as a possible value for
248         `markdown-reference-location` and
249         `markdown-footnote-location`.
250     -   Ask flyspell to ignore words in URLs, code fragments,
251         comments, and reference labels.
252     -   Make inline links, reference links, angle bracket URLs, and
253         plain URLs clickable.
254     -   Add an additional keybinding for toggling inline image
255         display, <kbd>C-c C-x C-i</kbd>.
256     -   Add a keybinding for toggling LaTeX math (_e_quation) support:
257         <kbd>C-c C-x C-e</kbd>.
258     -   Support Leanpub blocks (asides, info blocks, warnings, etc.).
259         These are simple extensions of the usual blockquote syntax.
260     -   Font lock, with markup hiding, for subscripts (e.g., `H~2~0`)
261         and superscripts (e.g., `334^10^`).  Thanks to Syohei Yoshida
262         for a patch on which this is based.  ([GH-134][])
263     -   Add basic font-lock support for inline attribute lists or
264         inline identifiers used by Pandoc, Python Markdown, PHP
265         Markdown Extra, Leanpub, etc.
266     -   Add basic font-lock support for Leanpub section identifiers and
267         page breaks.
268     -   Add basic font-lock support for common file inclusion syntax:
269         `<<(file)`, `<<[title](file)`, `<<[file]`, and `<<{file}`.
270     -   Add font lock support for Pandoc inline footnotes. ([GH-81][])
271     -   Raise footnote markers and inline footnote text, and
272         optionally hide markup.
273     -   Filling with now respects Pandoc line blocks.  ([GH-144][])
274     -   Add interactive link editing and insertion command
275         `markdown-insert-link`.  ([GH-199][])
276     -   Added <kbd>C-c C-d</kbd>, `markdown-do`, which is a
277         replacement for <kbd>C-c C-l</kbd>, `markdown-jump`.  In
278         addition to jumping between reference/footnote labels and
279         definitions, it also toggles GFM checkboxes.
280     -   Outline movement keys <kbd>C-c C-p</kbd>, <kbd>C-c C-n</kbd>,
281         <kbd>C-c C-f</kbd>, <kbd>C-c C-b</kbd>, and <kbd>C-c C-u</kbd>
282         now move between list items, when the point is in a list,
283         and move between headings otherwise.
284     -   New customization option `markdown-spaces-after-code-fence` to
285         control the number of spaces inserted after a code fence (` ``` `).
286         Thanks to Philipp Stephani for a patch.  ([GH-232][])
287     -   New customization option `markdown-gfm-uppercase-checkbox` which,
288         when non-nil, uses `[X]` to complete task list items instead of
289         `[x]`.  Thanks to Paul Rankin for a patch.  ([GH-236][])
290     -   Add prefix-specific prompts for styles (`C-c C-s`) and toggles
291         (`C-c C-x`).  These may be disabled if desired by setting
292         `markdown-enable-prefix-prompts` to `nil`.
294 *   Improvements:
296     -   Document customizable variables added in version 2.2 with
297         `:package-version` tags.
298     -   Better consistency of function names: predicate functions
299         ending in `-p` shouldn't modify match data.
300     -   Generalize rebinding of paragraph movement commands in case users
301         have customized `{forward,backward,mark}-paragraph` bindings.
302     -   Adjust point so that it is left at beginning of setext
303         headings in heading navigation commands.
304     -   Prevent inline link matching in code blocks.
305     -   When inserting a new reference definition, don't add blank
306         line after existing reference definitions.
307     -   `markdown-toggle-inline-images` now displays the status in the
308         minibuffer.
309     -   Increased default heading scaling range slightly, to make
310         level differences more pronounced when markup is hidden.
311     -   Reuse existing windows, when possible, rather than splitting
312         again in preferred direction. ([GH-129][])
313     -   Update known languages in `markdown-gfm-recognized-languages`.
314     -   Filling with `fill-region` now leaves code blocks unmodified.
315         ([GH-192][])
316     -   Avoid error when live-previewing a buffer that's not visiting
317         a file.  Thanks to Tianxiang Xiong for a patch.
318         ([GH-200][], [GH-201][])
319     -   Adaptive filling for Leanpub blocks.
320     -   Set variable `comment-use-syntax`.  ([GH-213][])
321     -   Support `electric-quote-inhibit-functions` for inhibiting
322         electric quoting in code spans and blocks.  Thanks to Philipp
323         Stephani for patches to both Emacs and Markdown Mode.
324         ([GH-220][])
325     -   Stop inhibiting line breaks inside links when filling.
326         ([GH-173][])
328 *   Bug fixes:
330     -   Fix spurious bold/italic faces in inline code. ([GH-172][])
331     -   Fix defun movement at end of buffer. ([GH-197][])
332     -   Fix bug with adjacent bold font-locking in a list
333         item. ([GH-176][])
334     -   Prevent matching italics, bold, and inline code in comments.
335     -   Prevent matching italics and bold in URLs.
336     -   Prevent matching links in inline code or comment spans.
337     -   Avoid infinite loop when promoting or demoting last section in
338         a buffer.
339     -   Fix font lock for subsequent inline links after a malformed
340         inline link.  ([GH-209][])
341     -   Prevent clobbering match data in
342         `markdown-font-lock-extend-region-function`.  Thanks to
343         Philipp Stephani for a patch.  ([GH-221][])
344     -   Fix incorrect indentation of inserted GFM code blocks in lists.
345         Thanks to Philipp Stephani for a patch. ([GH-215][])
346     -   Fix an issue with font lock for headings with code blocks immediately
347         afterwards, without whitespace. ([GH-234][])
349   [gh-81]:  https://github.com/jrblevin/markdown-mode/issues/81
350   [gh-123]: https://github.com/jrblevin/markdown-mode/issues/123
351   [gh-130]: https://github.com/jrblevin/markdown-mode/issues/130
352   [gh-134]: https://github.com/jrblevin/markdown-mode/issues/134
353   [gh-144]: https://github.com/jrblevin/markdown-mode/issues/144
354   [gh-164]: https://github.com/jrblevin/markdown-mode/issues/164
355   [gh-172]: https://github.com/jrblevin/markdown-mode/issues/172
356   [gh-173]: https://github.com/jrblevin/markdown-mode/issues/173
357   [gh-176]: https://github.com/jrblevin/markdown-mode/issues/176
358   [gh-185]: https://github.com/jrblevin/markdown-mode/issues/185
359   [gh-191]: https://github.com/jrblevin/markdown-mode/issues/191
360   [gh-192]: https://github.com/jrblevin/markdown-mode/issues/192
361   [gh-197]: https://github.com/jrblevin/markdown-mode/issues/197
362   [gh-199]: https://github.com/jrblevin/markdown-mode/issues/199
363   [gh-200]: https://github.com/jrblevin/markdown-mode/issues/200
364   [gh-201]: https://github.com/jrblevin/markdown-mode/issues/201
365   [gh-209]: https://github.com/jrblevin/markdown-mode/issues/209
366   [gh-213]: https://github.com/jrblevin/markdown-mode/issues/213
367   [gh-215]: https://github.com/jrblevin/markdown-mode/issues/215
368   [gh-220]: https://github.com/jrblevin/markdown-mode/pull/220
369   [gh-221]: https://github.com/jrblevin/markdown-mode/pull/221
370   [gh-232]: https://github.com/jrblevin/markdown-mode/pull/232
371   [gh-234]: https://github.com/jrblevin/markdown-mode/issues/234
372   [gh-236]: https://github.com/jrblevin/markdown-mode/pull/236
374 # Markdown Mode 2.2
376 *May 26, 2017*
378 Version 2.2 is a major new stable release and all users are encouraged
379 to upgrade.  Thanks to everyone who submitted bug reports, feature
380 suggestions, and especially patches.
382 *   **Breaking changes:**
384     -   Now use <kbd>C-c C-j</kbd> for inserting list items, like
385         AUCTeX and similar to other programming modes.  Since <kbd>C-c
386         C-j</kbd> was used for `markdown-jump` (for moving between
387         reference link/footnote markers and their definitions), it has
388         been changed to <kbd>C-c C-l</kbd> (think "leap" or "loop"
389         instead of jump).  It's also close to <kbd>C-c C-o</kbd> (used
390         for opening links).  ([GH-26][])
391     -   Insertion of `kbd` tags with <kbd>C-c C-s k</kbd> or
392         `markdown-insert-kbd`.
393     -   Add YAML metadata parsing.  Also allow multiple Pandoc
394         metadata, with tests.  Thanks to Danny McClanahan and Syohei
395         Yoshida.  ([GH-66][], [GH-91][], [GH-155][], [GH-156][],
396         [GH-157][])
397     -   Change the behavior of <kbd>C-c C-o</kbd>
398         (`markdown-follow-link-at-point`) so that if a link is a
399         complete URL, it will open in a browser.  Otherwise, open it
400         with `find-file` after stripping anchors and/or query strings.
401         ([GH-132][])
402     -   Make font lock for missing wiki links optional and disabled by
403         default.  Add new custom variable
404         `markdown-wiki-link-fontify-missing` to control this behavior.
405     -   The _function_ `markdown-enable-math` has been made obsolete
406         and renamed to `markdown-toggle-math`.  When called without an
407         argument, the result is to toggle this extension rather than
408         enable it.
410 *   New features:
412     -   Filling for definition list items. ([GH-13][])
413     -   Added option `markdown-gfm-downcase-languages` to use
414         lowercase language name in GFM code blocks.
415         ([GH-71][], [GH-73][])
416     -   Customizable live preview window split direction via
417         `markdown-split-window-direction`.  ([GH-129][], [GH-188][])
418     -   Variable-height headings via
419         `markdown-header-scaling`. ([GH-121][])
420     -   Implement inline image previews via
421         `markdown-toggle-inline-images` and <kbd>C-c C-i C-t</kbd>.
422         Thanks to Syohei Yoshida.  ([GH-122][], [GH-128][])
423     -   Added `markdown-wiki-link-search-subdirectories` to enable
424         searching for wiki link files in subdirectories. ([GH-174][])
425     -   Added option to automatically continue lists when `RET` is
426         pressed.  `markdown-indent-on-enter` now has three settings.
427         ([GH-179][])
428     -   Match fenced code blocks with language and info strings.
429         ([GH-184][])
430     -   Add smart Markdown block navigation commands <kbd>M-{</kbd>
431         and <kbd>M-}</kbd>.  These replace the
432         regular-expression-based "paragraph" movement commands
433         provided by Emacs, which do not recognize Markdown syntax
434         (e.g., headings inside of code blocks).  Also use
435         <kbd>M-h</kbd> for marking a block and <kbd>C-x n b</kbd> to
436         narrow to a block.
437     -   Add `markdown-nested-imenu-heading-index` as a customizable
438         option.  It may be disabled to instead generate a flat imenu
439         index.
440     -   Basic font lock and filling for definition lists.  As a side
441         effect, list item navigation and movement should also work.
442     -   Add command for toggling GFM task list items via
443         <kbd>C-c C-c C-x</kbd> (`markdown-toggle-gfm-checkbox`).
444     -   Ability to toggle wiki link support via a new custom variable
445         `markdown-enable-wiki-links`.  This may be set in a file local
446         variable.  Also added function `markdown-toggle-wiki-links`
447         and a menu item.
449 *   Improvements:
451     -   Menubar reorganization.  Grouped related actions together,
452         added missing commands, and added several toggle options to
453         the menu. ([GH-147][])
454     -   Use `toggle` menu style for macOS compatibility.
455     -   Remove autoload for `.text` files.  Thanks to Steve Purcell.
456         ([GH-118][])
457     -   Set own `adaptive-fill-regexp` so that `fill-paragraph` works
458         for list items.  Thanks to Syohei Yoshida for the patch.
459         ([GH-79][], [GH-80][])
460     -   Suppress minibuffer output when generated HTML is small.
461         Thanks to Syohei Yoshida.  ([GH-83][], [GH-86][])
462     -   Use GitHub fetcher for `markdown-mode` on MELPA.  ([GH-84][])
463     -   Improve fenced code block parsing.  Thanks to Danny McClanahan.
464         ([GH-85][], [GH-95][])
465     -   Markdown Mode is now automatically tested against Emacs
466         24.1-24.5 and 25.1-25.2.  ([GH-99][])
467     -   Make live-preview mode follow min or max point.  Thanks to
468         Danny McClanahan.  ([GH-102][])
469     -   Improved font-lock performance. ([GH-119][])
470     -   Maintain cursor position when indenting instead of moving to
471         the beginning of the line.  Thanks to Isaac Hodes.
472         ([GH-125][])
473     -   Add used language names to front of list of known languages.
474         ([GH-135][])
475     -   Support basic TOML metadata.  Thanks to Jorge Israel Peña.
476         ([GH-137][])
477     -   Prohibit setext heading text from starting with hyphens,
478         spaces or tabs, so that there is no ambiguity between setext
479         headings and in-progress lists.  ([GH-139][], [GH-143][])
480     -   Ignore heading lines in `fill-paragraph`.  Thanks to Syohei
481         Yoshida.  ([GH-159][], [GH-162][])
482     -   Improve matching of multiple math blocks with non-math text in
483         between.  Thanks to Dave Kleinschmidt for a patch.
484         ([GH-168][])
485     -   Prevent `fill-paragraph` from filling lines in code blocks.
486         ([GH-169][])
487     -   Fix font lock for links with URLs containing parentheses.
488         ([GH-170][])
489     -   `fill-paragraph` now respects paragraph boundaries within
490         blockquotes.  ([GH-186][])
491     -   Set mark when calling `markdown-up-heading`.
492     -   Improved font locking after empty GFM code block insertion.
493     -   Fix spurious italics from underscores in URLs.
494     -   Respect `font-lock-mode` being nil.  Only call
495         `font-lock-refresh-defaults` if `font-lock-mode` is non-nil to
496         prevent it from being turned on when disabled by user.  Thanks
497         to Tom May for the patch.
498     -   Fix list item insertion on ordered lists with hash marks
499         (Pandoc "fancy lists").
500     -   Treat polymode blocks as code blocks when parsing the buffer.
501     -   Require whitespace atx heading hashmarks, as required by the
502         original atx specification (but not enforced by Markdown.pl).
503         The benefit is that it prevents false positives for #hashtags
504         and things like "Engine #1" when lines wrap.
505     -   Complete heading markup when point is on an setext heading and
506         `markdown-insert-header-dwim` is invoked
507         (<kbd>C-c C-t h</kbd>).
508     -   Better point position after inserting asymmetric atx headings.
510 *   Bug fixes:
512     -   Fix `scripts/get-recognized-gfm-languages.el`, which skipped
513         languages with spaces.  ([GH-72][], [GH-82][])
514     -   `README.md` specified Arch (AUR) package (`emacs-goodies-el`),
515         which did not exist.  ([GH-74][])
516     -   Don't accidentally override user entries in `auto-mode-alist`.
517         ([GH-127][])
518     -   Fix `markdown-cycle` issue with heading-like strings in code
519         blocks.  Thanks to Syohei Yoshida.  ([GH-75][], [GH-76][])
520     -   Fix moving same level heading over code block issue.  Thanks
521         to Syohei Yoshida.  ([GH-77][], [GH-78][])
522     -   Don't insert empty title strings for links.  Thanks to
523         Sebastian Wiesner for the patch.  ([GH-89][])
524     -   Fix possible infinite loop in `markdown-cleanup-list-numbers`.
525         Thanks to Danny McClanahan.  ([GH-98][], [GH-100][])
526     -   Fix an args-out-of-range error due to the syntax-propertize
527         function returning point which is larger than `point-max`.
528         Thanks to Syohei Yoshida. ([GH-142][])
529     -   Respect narrowed region in `markdown-find-previous-prop`.
530         Thanks to Vitalie Spinu.  ([GH-109][])
531     -   Move point at least 1 char in
532         `markdown-match-propertized-text` to avoid possible infinite
533         loop in font-lock.  Thanks to Vitalie Spinu.  ([GH-110][])
534     -   Fix issues where buffers could be marked as modified when no
535         modifications were made.  ([GH-115][], [GH-116][], [GH-146][])
536     -   Fix an issue where comments of the form `<!-- > comment -->`
537         were not correctly identified.  ([GH-117][])
538     -   Prevent spurious bold fontification.  Thanks to Kévin Le
539         Gouguec.  ([GH-124][])
540     -   Keep metadata visible when cycling visibility.  ([GH-136][])
541     -   `markdown-syntax-propertize-extend-region` should not
542         overwrite match-data, which caused issues with
543         `replace-regexp`, etc.  ([GH-104][], [GH-105][])
544     -   Don't list heading-like lines in code blocks or metadata in
545         imenu.  Thanks to Syohei Yoshida.  ([GH-145][], [GH-154][])
546     -   Fix an issue where fill paragraph wouldn't work following
547         unclosed left square brackets.  ([GH-148][], [GH-161][])
548     -   Fix default language presented when inserting GFM code blocks.
549         Thanks to Conal Elliot for a patch.  ([GH-152][])
550     -   Backspace now always deletes characters if a region is
551         specified.  Thanks to Syohei Yoshida.
552         ([GH-166][], [GH-167][])
553     -   Fix `markdown-header-face` inherit from nil error, e.g., when
554         exporting HTML from an Org mode file containing a Markdown
555         source block.  Thanks to Moogen Tian for a patch.
556         ([GH-190][], [GH-193][])
557     -   Inserting a reference link no longer causes an "args out of
558         range" commit error when the existing reference label is a
559         single commit character.
560     -   Fix to honor location setting when inserting reference
561         definitions.
562     -   Fixed an issue where, if there is special markup at the end of
563         the buffer, deleting a character backward would cause the
564         font-lock faces to disappear.
565     -   Fix incorrect matching of italic text due to underscores in
566         math mode.  Thanks also to Dave Kleinschmidt.
567     -   Fix italic highlighting issue when each line or both lines are list.
568     -   Handle false positive italics across list items.
570   [gh-13]: https://github.com/jrblevin/markdown-mode/issues/13
571   [gh-26]: https://github.com/jrblevin/markdown-mode/issues/26
572   [gh-66]: https://github.com/jrblevin/markdown-mode/issues/66
573   [gh-71]: https://github.com/jrblevin/markdown-mode/issues/71
574   [gh-72]: https://github.com/jrblevin/markdown-mode/issues/72
575   [gh-73]: https://github.com/jrblevin/markdown-mode/issues/73
576   [gh-74]: https://github.com/jrblevin/markdown-mode/issues/74
577   [gh-75]: https://github.com/jrblevin/markdown-mode/issues/75
578   [gh-76]: https://github.com/jrblevin/markdown-mode/pull/76
579   [gh-77]: https://github.com/jrblevin/markdown-mode/pull/77
580   [gh-78]: https://github.com/jrblevin/markdown-mode/pull/78
581   [gh-79]: https://github.com/jrblevin/markdown-mode/issues/79
582   [gh-80]: https://github.com/jrblevin/markdown-mode/pull/80
583   [gh-82]: https://github.com/jrblevin/markdown-mode/pull/82
584   [gh-83]: https://github.com/jrblevin/markdown-mode/issues/83
585   [gh-84]: https://github.com/jrblevin/markdown-mode/issues/84
586   [gh-86]: https://github.com/jrblevin/markdown-mode/pull/86
587   [gh-85]: https://github.com/jrblevin/markdown-mode/issues/85
588   [gh-89]: https://github.com/jrblevin/markdown-mode/pull/89
589   [gh-91]: https://github.com/jrblevin/markdown-mode/pull/91
590   [gh-95]: https://github.com/jrblevin/markdown-mode/pull/95
591   [gh-98]: https://github.com/jrblevin/markdown-mode/issues/98
592   [gh-99]: https://github.com/jrblevin/markdown-mode/pull/99
593   [gh-100]: https://github.com/jrblevin/markdown-mode/pull/100
594   [gh-102]: https://github.com/jrblevin/markdown-mode/pull/102
595   [gh-104]: https://github.com/jrblevin/markdown-mode/issues/104
596   [gh-105]: https://github.com/jrblevin/markdown-mode/pull/105
597   [gh-109]: https://github.com/jrblevin/markdown-mode/pull/109
598   [gh-110]: https://github.com/jrblevin/markdown-mode/pull/110
599   [gh-115]: https://github.com/jrblevin/markdown-mode/issues/115
600   [gh-116]: https://github.com/jrblevin/markdown-mode/pull/116
601   [gh-117]: https://github.com/jrblevin/markdown-mode/issues/117
602   [gh-118]: https://github.com/jrblevin/markdown-mode/pull/118
603   [gh-119]: https://github.com/jrblevin/markdown-mode/issues/119
604   [gh-121]: https://github.com/jrblevin/markdown-mode/issues/121
605   [gh-122]: https://github.com/jrblevin/markdown-mode/issues/122
606   [gh-124]: https://github.com/jrblevin/markdown-mode/issues/124
607   [gh-125]: https://github.com/jrblevin/markdown-mode/pull/125
608   [gh-127]: https://github.com/jrblevin/markdown-mode/issues/127
609   [gh-128]: https://github.com/jrblevin/markdown-mode/pull/128
610   [gh-129]: https://github.com/jrblevin/markdown-mode/issues/129
611   [gh-132]: https://github.com/jrblevin/markdown-mode/pull/132
612   [gh-135]: https://github.com/jrblevin/markdown-mode/issues/135
613   [gh-136]: https://github.com/jrblevin/markdown-mode/issues/136
614   [gh-137]: https://github.com/jrblevin/markdown-mode/issues/137
615   [gh-139]: https://github.com/jrblevin/markdown-mode/issues/139
616   [gh-142]: https://github.com/jrblevin/markdown-mode/pull/142
617   [gh-143]: https://github.com/jrblevin/markdown-mode/issues/143
618   [gh-145]: https://github.com/jrblevin/markdown-mode/issues/145
619   [gh-154]: https://github.com/jrblevin/markdown-mode/pull/154
620   [gh-146]: https://github.com/jrblevin/markdown-mode/pull/146
621   [gh-147]: https://github.com/jrblevin/markdown-mode/issues/147
622   [gh-148]: https://github.com/jrblevin/markdown-mode/issues/148
623   [gh-152]: https://github.com/jrblevin/markdown-mode/issues/152
624   [gh-155]: https://github.com/jrblevin/markdown-mode/issues/155
625   [gh-156]: https://github.com/jrblevin/markdown-mode/issues/156
626   [gh-157]: https://github.com/jrblevin/markdown-mode/pull/157
627   [gh-159]: https://github.com/jrblevin/markdown-mode/issues/159
628   [gh-161]: https://github.com/jrblevin/markdown-mode/issues/161
629   [gh-162]: https://github.com/jrblevin/markdown-mode/pull/162
630   [gh-166]: https://github.com/jrblevin/markdown-mode/issues/166
631   [gh-167]: https://github.com/jrblevin/markdown-mode/pull/167
632   [gh-168]: https://github.com/jrblevin/markdown-mode/pull/168
633   [gh-169]: https://github.com/jrblevin/markdown-mode/issues/169
634   [gh-170]: https://github.com/jrblevin/markdown-mode/issues/170
635   [gh-174]: https://github.com/jrblevin/markdown-mode/issues/174
636   [gh-179]: https://github.com/jrblevin/markdown-mode/issues/179
637   [gh-184]: https://github.com/jrblevin/markdown-mode/issues/184
638   [gh-186]: https://github.com/jrblevin/markdown-mode/issues/186
639   [gh-188]: https://github.com/jrblevin/markdown-mode/pull/188
640   [gh-190]: https://github.com/jrblevin/markdown-mode/pull/190
641   [gh-193]: https://github.com/jrblevin/markdown-mode/issues/193
643 # Markdown Mode 2.1
645 *January 9, 2016*
647 Version 2.1 is a major new stable release and all users are encouraged
648 to upgrade.  The many new features and bug fixes included are
649 described below.
651 Markdown Mode is developed and tested primarily for compatibility with
652 GNU Emacs versions 24.3 and later.  It requires `cl-lib` version 0.5
653 or later.  This library has been bundled with GNU Emacs since version
654 24.3.  Users of GNU Emacs 24.1 and 24.2 can install `cl-lib` using
655 `M-x package-install RET cl-lib`.
657 This release of Markdown Mode contains patches written by many
658 individuals including Masayuki Ataka, Jonas Bernoulli, Roger Bolsius,
659 Daniel Brotsky, Julien Danjou, Samuel Freilich, David Glasser, Marijn
660 Haverbeke, Antonis Kanouras, Keshav Kini, Vasily Korytov, Danny
661 McClanahan, Matt McClure, Howard Melman, Makoto Motohashi, Jon
662 Mountjoy, Pierre Neidhardt, Spanti Nicola, Paul W. Rankin, Christophe
663 Rhodes, Tim Visher, and Syohei Yoshida.  Many others also submitted
664 bug reports. Thanks to everyone for your contributions.
666 *   **Breaking changes:**
668     -   In GFM Mode, `visual-line-mode` is no longer enabled by
669         default.  A `gfm-mode-hook` was added, which could be used to
670         keep `visual-line-mode` on by default in `gfm-mode`.
671         ([GH-31][])
673 *   New features:
675     -   Add automatically updating live preview functionality
676         (<kbd>C-c C-c l</kbd>) via the native `eww` browser.
677         ([GH-36][], [GH-53][], [GH-57][], [GH-58][], [GH-63][])
678     -   Use `autoload` to enable `markdown-mode` in `auto-mode-alist`
679         for files with `.text`, `.markdown`, and `.md` extensions.
680     -   Use Travis CI for automated build testing.
681     -   ATX heading subtree promotion and demotion via
682         <kbd>M-S-LEFT</kbd>, and <kbd>M-S-RIGHT</kbd>.
683     -   ATX heading subtree moving up and down via <kbd>M-S-UP</kbd>
684         and <kbd>M-S-DOWN</kbd>.
685     -   Convert inline links to reference links when
686         `markdown-insert-reference-link-dwim` is used when the point
687         is at an inline link.
688     -   Allow linking to multiple stylesheets in `markdown-css-paths`
689         list.  Use stylesheets for both preview and export. Previous
690         `markdown-css-path` (singular) is now deprecated.
691     -   Customizable default unordered list marker via
692         `markdown-unordered-list-item-prefix`.
693     -   Add asymmetric ATX heading adornment option
694         `markdown-asymmetric-header`.
695     -   Font lock for `<kbd>` tags.
696     -   Support GFM-style code blocks in `markdown-mode` (as well as
697         `gfm-mode`).  ([GH-2][])
698     -   New function `markdown-electric-backquote` will prompt for a
699         language name for GFM code blocks.  This can be disabled by
700         customizing the variable
701         `markdown-gfm-use-electric-backquote`.  ([GH-9][])
702     -   Completion of programming language names for GFM code blocks.
703         A list of pre-defined languages is included, but this can be
704         augmented by setting `markdown-gfm-additional-languages`.
705         ([GH-38][], [GH-54][], [GH-59][], [GH-60][], [GH-64][])
706     -   Strikethrough support in `gfm-mode`.
707     -   Support for GFM toggling checkboxes `mouse-1` or
708         <kbd>RET</kbd>.  This is controlled by a new custom variable,
709         `markdown-make-gfm-checkboxes-buttons`.  Thanks to Howard
710         Melman for a patch.  ([GH-7][])
711     -   Font lock and filling for Pandoc "fancy lists," which use `#`
712         as the list marker.  ([GH-3][])
713     -   Basic support for filling of definition lists.  ([GH-20][])
714     -   Support [Ikiwiki](http://ikiwiki.info/)-style search for wiki links that allows
715         links relative to parent directories.  Enable this by setting
716         `markdown-wiki-link-search-parent-directories`.
717         ([GH-8][], [GH-21][])
719 *   Improvements:
721     -   General font lock improvements for comments, code blocks,
722         blockquotes, headings, horizontal rules, bold, and italics.
723         ([GH-67][], [GH-68][])
724     -   Separate highlighting for Markdown markup characters
725         (asterisks, underscores, backquotes, etc.) to aid in
726         readability.
727     -   Font lock for bold, italics, and LaTeX math work inside block
728         elements such as headings and blockquotes.  ([GH-39][])
729     -   Display a link to the GitHub repository in the MELPA
730         description.  ([GH-37][])
732 *   Bug fixes:
734     -   Fix bug in `markdown-complete-region/buffer` where level-two
735         Setext headings could be confused with horizontal rules.
736         Includes a unit test.  Thanks to Gunnar Franke for the report.
737     -   Fix filling when a decimal number appears at column zero,
738         which could be confused with an ordered list item.
739     -   Fix buffer-wide markup completion.
740     -   Fix font-lock for GFM code blocks without language keywords.
741     -   Improved Setext header insertion to support wide characters.
742     -   Fix expensive `paragraph-separate` regular expression.
743     -   Make `comment-auto-fill-only-comments` a buffer-local
744         variable, which allows for better default filling behavior in
745         cases where the global variable is non-`nil`.
746     -   Fix Emacs 23 compatibility by checking for
747         `font-lock-refresh-defaults` before calling it.
748     -   Handle reference definitions when filling paragraphs.
749     -   Improve filling of list items with indentation.
750     -   Properly handle footnotes when filling.
751     -   Fix issues with markdown-footnote-kill and related functions.
752     -   Improve font lock for fenced code blocks.
753     -   Avoid avoid overwriting source file when exporting if source
754         file has `.html` extension.
755     -   Fix and improve ordered list behavior to preserve digit
756         spacing and avoid an infinite loop in certain cases.  Adjust
757         ordered list whitespace when marker digit count increases.
758     -   Improve reference definition regular expression to avoid
759         matching multiple reference links in one line.
760     -   Allow spaces in fenced code language identifiers.  ([GH-22][])
761     -   Improve font lock for preformatted blocks and fenced code
762         blocks.
763     -   Fix out-of-order HTML output.  ([GH-14][])
764     -   Add console-friendly backspace and tab bindings.  ([GH-15][])
765     -   Better treatment of files without extensions for wiki links.
766         When files have no extensions, don't append a lone period.
767         ([GH-23][])
768     -   Call `looking-back` with two arguments for compatibility with
769         Emacs 25.1.
770     -   Make `(beginning-of-defun -1)` go to next title when point is
771         at beginning of defun.  ([GH-34][])
772     -   Ignore headings in code blocks for font lock, movement, and
773         visibility cycling.
774         ([GH-27][], [GH-33][], [GH-35][], [GH-40][], [GH-41][])
775     -   Don't highlight wiki links in code blocks.  ([GH-17][])
776     -   Don't move to links in code blocks with <kbd>C-c C-p</kbd> and
777         <kbd>C-c C-n</kbd>.
778     -   Fix hanging indentation for list items and single-line
779         preformatted blocks.  ([GH-16][], [GH-28][], [GH-30][])
780     -   Better rejection of false positives for italics with respect
781         to other inline elements (inline code and bold).
782     -   Predicate functions should not modify match data.
783     -   Use correct list marker from previous list level when using
784         <kbd>C-u M-RET</kbd> to insert a dedented list item.  Prevent
785         an infinite loop in some cases.  ([GH-4][])
786     -   Reduce lag when scrolling or inserting text into large files.
787         ([GH-30][], [GH-101][])
788     -   Avoid confusing tramp errors with malformed wiki links.
789         ([GH-65][])
791   [gh-2]: https://github.com/jrblevin/markdown-mode/pull/2
792   [gh-3]: https://github.com/jrblevin/markdown-mode/pull/3
793   [gh-4]: https://github.com/jrblevin/markdown-mode/issues/4
794   [gh-7]: https://github.com/jrblevin/markdown-mode/issues/7
795   [gh-8]: https://github.com/jrblevin/markdown-mode/issues/8
796   [gh-9]: https://github.com/jrblevin/markdown-mode/issues/9
797   [gh-14]: https://github.com/jrblevin/markdown-mode/issues/14
798   [gh-15]: https://github.com/jrblevin/markdown-mode/issues/15
799   [gh-16]: https://github.com/jrblevin/markdown-mode/issues/16
800   [gh-17]: https://github.com/jrblevin/markdown-mode/issues/17
801   [gh-18]: https://github.com/jrblevin/markdown-mode/issues/18
802   [gh-20]: https://github.com/jrblevin/markdown-mode/issues/20
803   [gh-21]: https://github.com/jrblevin/markdown-mode/issues/21
804   [gh-22]: https://github.com/jrblevin/markdown-mode/issues/22
805   [gh-23]: https://github.com/jrblevin/markdown-mode/issues/23
806   [gh-27]: https://github.com/jrblevin/markdown-mode/issues/27
807   [gh-28]: https://github.com/jrblevin/markdown-mode/issues/28
808   [gh-30]: https://github.com/jrblevin/markdown-mode/issues/30
809   [gh-31]: https://github.com/jrblevin/markdown-mode/issues/31
810   [gh-32]: https://github.com/jrblevin/markdown-mode/pull/32
811   [gh-33]: https://github.com/jrblevin/markdown-mode/issues/33
812   [gh-34]: https://github.com/jrblevin/markdown-mode/pull/34
813   [gh-35]: https://github.com/jrblevin/markdown-mode/pull/35
814   [gh-36]: https://github.com/jrblevin/markdown-mode/pull/36
815   [gh-37]: https://github.com/jrblevin/markdown-mode/issues/37
816   [gh-38]: https://github.com/jrblevin/markdown-mode/issues/38
817   [gh-39]: https://github.com/jrblevin/markdown-mode/issues/39
818   [gh-40]: https://github.com/jrblevin/markdown-mode/pull/40
819   [gh-41]: https://github.com/jrblevin/markdown-mode/pull/41
820   [gh-53]: https://github.com/jrblevin/markdown-mode/pull/53
821   [gh-54]: https://github.com/jrblevin/markdown-mode/pull/54
822   [gh-57]: https://github.com/jrblevin/markdown-mode/pull/57
823   [gh-58]: https://github.com/jrblevin/markdown-mode/pull/58
824   [gh-59]: https://github.com/jrblevin/markdown-mode/pull/59
825   [gh-60]: https://github.com/jrblevin/markdown-mode/pull/60
826   [gh-63]: https://github.com/jrblevin/markdown-mode/pull/63
827   [gh-64]: https://github.com/jrblevin/markdown-mode/pull/64
828   [gh-65]: https://github.com/jrblevin/markdown-mode/pull/65
829   [gh-67]: https://github.com/jrblevin/markdown-mode/pull/67
830   [gh-68]: https://github.com/jrblevin/markdown-mode/pull/68
831   [gh-101]: https://github.com/jrblevin/markdown-mode/issues/101
833 # Markdown Mode 2.0
835 *March 24, 2013*
837 Version 2.0 is a major new stable release with many new features,
838 including some changes to keybindings for element insertion and
839 outline navigation.  In summary, Markdown Mode now has improved
840 keybindings, smarter markup insertion commands, a general markup
841 removal command, markup completion (normalization), markup promotion
842 and demotion, list and region editing, many syntax highlighting
843 improvements, new and improved movement commands, and generalized link
844 following and movement.
846 *   **Breaking changes:**
848     -    Physical style element insertion commands prefixed by
849          <kbd>C-c C-p</kbd> have been removed in favor of their
850          logical style counterparts prefixed by <kbd>C-c C-s</kbd>.
851     -    Shift is now the preferred way to distinguish keybindings for
852          two related elements.  For example, you can insert an inline
853          link with <kbd>C-c C-a l</kbd> or a reference link with
854          <kbd>C-c C-a L</kbd>.  The latter keybinding is new and
855          preferred over <kbd>C-c C-a r</kbd>, which is deprecated.
856     -    Footnote keybindings have been moved away from the
857          <kbd>C-c C-f n</kbd> prefix.
858     -    Several other new keybindings have been introduced and are
859          described in more detail below.
860     -    Removed wiki link following with `RET` and
861          `markdown-follow-wiki-link-on-enter` setting.  Use the
862          unified following (open link) command <kbd>C-c C-o</kbd>
863          instead.
865 *   New features:
867     -    Fast heading insertion with a single command which
868          automatically calculates the type (atx or setext) and level.
869          Prefix with <kbd>C-u</kbd> to promote the heading by one
870          level or <kbd>C-u C-u</kbd> to demote the heading by one
871          level.  Headings with a specific level or type can still be
872          inserted quickly with specific keybindings.
873     -    Easily kill an element (e.g., a link or reference definition)
874          at the point with <kbd>C-c C-k</kbd> and store the most
875          important part in the kill ring (e.g., the link text or URL).
876     -    Markup completion (<kbd>C-c C-]</kbd>) normalizes the markup
877          for an element (e.g., it balances hash marks and removing
878          extra whitespace for atx headings).
879     -    Markup promotion and demotion via <kbd>C-c C--</kbd> and
880          <kbd>C-c C-=</kbd>, respectively.  The sequences
881          <kbd>M-UP</kbd> and <kbd>M-DOWN</kbd> may
882          also be used.
883     -    List editing: move list items up and down with
884          <kbd>M-UP</kbd> and <kbd>M-DOWN</kbd>.
885          Indent and exdent list items with <kbd>M-LEFT</kbd>
886          and <kbd>M-RIGHT</kbd>.
887     -    Region editing: indent and exdent regions, with tab stops
888          determined by context, using <kbd>C-c <</kbd> and
889          <kbd>C-c ></kbd> (as in `python-mode`).
890     -    Smart list item insertion with <kbd>M-RET</kbd>, with
891          indentation and marker determined by the surrounding context.
892          Prefix with <kbd>C-u</kbd> to decrease the indentation by one
893          level or <kbd>C-u C-u</kbd> to increase the indentation one
894          level.
895     -    Quickly jump between reference definitions and
896          reference-style links and between footnote markers and
897          footnote text with <kbd>C-c C-j</kbd>.  Create undefined
898          references when jumping from a reference link.  When jumping
899          back, present a buffer with buttons for selecting which link
900          to jump to.
901     -    Revised outline navigation commands, following `org-mode`.
902          This frees up the sexp navigation keys <kbd>C-M-f</kbd> and
903          <kbd>C-M-b</kbd> which can be useful in Markdown documents
904          which have many matching delimiters, as well as the defun
905          navigation keys <kbd>C-M-a</kbd> and <kbd>C-M-e</kbd>.
906     -    Previous/next section movement with <kbd>C-M-a</kbd> and
907          <kbd>C-M-e</kbd> (in Emacs parlance, this is movement by
908          defun).  Mark the current section with <kbd>C-M-h</kbd>.
909     -    Previous/next paragraph movement via <kbd>M-{</kbd> and
910          <kbd>M-}</kbd>.
911     -    Previous/next block movement with <kbd>C-u M-{</kbd> and
912          <kbd>C-u M-}</kbd>.
913     -    Customizable reference link location via
914          `markdown-reference-location`.
915     -    Font lock for title strings in inline links.
916     -    Subtle syntax highlighting for hard line breaks.
917     -    In GFM Mode, change italic font lock behavior to match GFM
918          specification regarding underscores in words.
919     -    Insertion command (<kbd>C-c C-s P</kbd>) for GFM quoted code
920          blocks.
921     -    Syntax highlighting for MultiMarkdown metadata and Pandoc
922          title blocks.
923     -    Added before and after export hooks
924          `markdown-before-export-hook` and
925          `markdown-after-export-hook`.
926     -    Added a library of regression tests which currently contains
927          160 unit tests.
929 *   Improvements:
931     -    ATX heading insertion will use current line as heading text
932          if not blank and there is no active region.
933     -    Setext heading insertion will prompt for heading title when
934          there is no active region.
935     -    When the point is at a heading, the heading insertion
936          commands will replace the heading at point with a heading of
937          the requested level and type.
938     -    When there is no active region, the bold, italic, code, link,
939          and image insertion commands will operate on the word at
940          point, if any, so that you don't have to have an active
941          selection for simple modifications.
942     -    Repeating the bold, italic, or code insertion commands when
943          the point is at an element of the corresponding type will
944          remove the markup.
945     -    Indentation of preformatted text and blockquotes will be
946          adjusted automatically in contexts where more indentation is
947          required, as in nested lists.  (For example, in Markdown, a
948          preformatted text block inside a first-level list item must
949          have eight spaces of indentation.)
950     -    Improved reference link insertion with label completion:
951            + Use word at point as link text, if possible, when there
952              is no active region.
953            + Tab completion of reference labels from the set of
954              currently defined references.
955            + Reference link insertion no longer prompts for a URL or
956              title if the label is already defined.
957            + If no URL is given, create an empty reference definition
958              and move the point there.
959     -    Basic reference-style image markup insertion.
960     -    Multiple horizontal rule styles, `markdown-hr-strings`,
961          customizable as a list of strings, which can be cycled
962          through.
963     -    New URL insertion command for inserting plain URLs delimited
964          by angle brackets (<kbd>C-c C-a u</kbd>).  Works on URL at
965          point, if any, when there is no active region.
966     -    Generally improved insertion commands with respect to
967          insertion of surrounding whitespace and point position after
968          insertion (e.g., ensuring blank lines before and after newly
969          inserted headings and horizontal rules).
970     -    Unified link following: open links in a browser and wiki
971          links in a new buffer with the same keybinding (<kbd>C-c
972          C-o</kbd>).  This supersedes the separate wiki link following
973          command (<kbd>C-c C-w</kbd>).
974     -    Generalized link movement and following: move between and
975          open all link types (inline, reference, wiki, angle URIs)
976          using the same key bindings (<kbd>M-n</kbd> and
977          <kbd>M-p</kbd>).  Previously, these commands only moved
978          between wiki links, but with the above following enhancement,
979          moving between hyperlinks of all types is more useful.
980     -    Syntax highlighting for GFM quoted code blocks with an
981          optional language keyword.
982     -    Dynamic loading and unloading for math support with
983          refontification.
984     -    Allow underscores and colons in equation labels in math mode.
985     -    Syntax highlighting improvements: faster identification of
986          preformatted blocks.  Markdown Mode adheres to the four space
987          rule for nested list items: in a list item of level _n_,
988          preformatted text must be indented at least 4(_n_ + 1)
989          spaces.
990     -    More inclusive blockquote regular expression highlights
991          blockquotes with leading indentation, when appropriate.
992     -    Regular expression optimization for URI matching.
993     -    Numerous other improvements for more accurate syntax
994          highlighting.
995     -    Respect hard line breaks when filling paragraphs.
996     -    Add indentation positions: preceding list markers and pre
997          block position.
998     -    Use button-map for navigating undefined references, so that
999          references can be navigated via the keyboard by pressing
1000          <kbd>TAB</kbd> and <kbd>S-TAB</kbd>.
1001     -    Use newer `use-region-p` when possible to check for active
1002          region, with fallbacks for older Emacsen and Xemacs.
1003     -    Clean up whitespace after deleting footnote text.
1004     -    Use adaptive filling for list items and blockquotes.
1005     -    Treat all list items (any marker type) the same way with respect
1006          to filling.
1007     -    Retain the `>` prefix when filling blockquotes.
1008     -    Fill list items inside of blockquotes.
1009     -    Numerous other internal improvements to make the code base
1010          more robust.
1012 *   Bug fixes:
1014     -    Fix bug in heading visibility cycling introduced in version
1015          1.9 where the level of headings was being calculated
1016          incorrectly.
1017     -    Fix problems inserting ATX headings at end of buffer.
1018     -    Support small Setext headings (with fewer than three
1019          characters).
1020     -    Several improvements to inline code syntax highlighting.
1021     -    Fix some edge cases regarding escaping, spaces, etc. for bold
1022          and italic font lock.
1023     -    Prohibit newlines and tabs immediately after opening bold and
1024          italic delimiters.  This fixes a bug where italics would not
1025          be highlighted following a horizontal rule
1026     -    Improved multi-line font lock performance for large files.
1027     -    Improved multi-line font lock at beginning of buffer.
1028     -    List items with any of the three markers are filled in the
1029          same way (previously list items starting with `+` were not
1030          filled with hanging indentation).
1031     -    Fix end detection for empty list items.  Don't skip over the
1032          whitespace following the marker on the same line.
1033          Previously, empty list items were not being detected properly
1034          by `markdown-cur-list-item-bounds` as a result of this.
1035     -    Don't exclude `[^]`, which is a valid reference tag (but
1036          let's please stick to alphanumeric characters).
1037     -    No longer highlight escaped wiki links.
1038     -    Fix line number buttons for reference checking and make all
1039          buttons clickable.
1040     -    Fix killing of footnotes with no text.
1041     -    Fix escaping in `markdown-xhtml-standalone-regexp`.
1042     -    Fix a font-lock edge case involving footnote markers
1043          preceding inline links.
1044     -    More accurate font-lock for ATX headings in edge cases.
1045     -    Fix killing of footnotes from footnote text.
1047 --- ---
1049 # Markdown Mode 1.9
1051 *January 1, 2013*
1053 Version 1.9 is a major new stable release with important bug fixes.
1055 *   New features:
1057     -    Support for setext-style headers in `outline-mode`.  Thanks
1058          to Shigeru Fukaya.
1059     -    Font lock for tilde-fenced code blocks.
1060     -    Reference link insertion (<kbd>C-c C-a r</kbd>).
1061     -    Support two forms of aliased wiki links:
1062          `[[link text|PageName]]` and `[[PageName|link text]]`
1063          (`markdown-wiki-link-alias-first`).
1064     -    Footnote support: font lock and insertion, deletion, and
1065          navigation functions for footnotes (prefixed by
1066          <kbd>C-c C-f</kbd>; following for wiki links is now
1067          <kbd>C-c C-w</kbd>).  Thanks to Joost Kremers.
1068     -    Improved preview and export commands.  Thanks to Donald
1069          Ephraim Curtis.
1070     -    `imenu` support.  Thanks to Akinori Musha.
1071     -    Added autoload token for `gfm-mode`.  Thanks to Max Penet and
1072          Peter Eisentraut for the suggestion.
1073     -    Optional character set declaration in XHTML output.  Thanks
1074          to François Gannaz for the suggestion.
1075     -    Smart unindentation when pressing delete at the beginning of
1076          a line.  Thanks to Zhenlei Jia.
1077     -    Optional prefix argument to <kbd>C-c C-w</kbd> for opening
1078          wiki links in another window.
1079     -    Open inline and reference links and inline URIs in browser
1080          (<kbd>C-c C-o</kbd>).  Thanks to Peter Jones.
1081     -    Open files in a standalone previewer or editor
1082          (<kbd>C-c C-c o</kbd>).
1083     -    Clean up numbered/ordered lists (<kbd>C-c C-c n</kbd>).
1084          Thanks to Donald Ephraim Curtis.
1085     -    Save Markdown output to kill ring (copy to clipboard)
1086          (<kbd>C-c C-c w</kbd>).  Thanks to Donald Ephraim Curtis.
1088 *   Improvements:
1090     -    Improve `markdown-mode-hook` docstring.  Thanks to Shigeru
1091          Fukaya for the more precise description.
1092     -    Don't require Common Lisp extensions at run time.  Thanks to
1093          Shigeru Fukaya.
1094     -    Prefer `visual-line-mode`, the replacement for
1095          `longlines-mode`, when in `gfm-mode`.  Thanks to Christopher
1096          J. Madsen.
1097     -    Proper GitHub wiki link handling in `gfm-mode`.  Thanks to
1098          Kevin Porter.
1099     -    XEmacs compatibility:
1100         -    Avoid malformed list errors during font definitions.
1101         -    Handle replace-regexp-in-string.
1102         -    Use text properties instead of overlays.
1103         -    Fall back to `set-buffer-modified-p` when
1104             `restore-buffer-modified-p` is unavailable.
1105         -    Many additional fixes.  Thanks to Michael Sperber.
1106     -    Handle wiki links in buffers not associated with a file.
1107     -    Update autoload documentation to support byte compilation.
1108     -    Option to use `-` instead of `_` for wiki links in
1109          `gfm-mode`.
1110     -    Add two tab stops to possible indentation positions following
1111          list items.
1113 *   Bug fixes:
1115     -    Fixed a bug which caused unusual behavior in functions
1116          performing search, replace, and/or matching operations.
1117          Thanks to Christopher J. Madsen for the patch.
1118     -    Fixed a bug which caused an incompatibility with
1119          `orgtbl-mode`.  Thanks to Vegard Vesterheim for the report
1120          and to Carsten Dominik for a patch.
1121     -    Fixed a bug where reference links at the beginning of a line
1122          would be mistaken for reference definitions.
1123     -    Improved font lock for headers.
1124     -    Improved font lock for reference definitions.  Thanks to Ian
1125          Yang.
1126     -    Avoid byte compiler warning about `region-exists-p` in GNU
1127          Emacs.
1128     -    Additional key bindings for cross-platform header cycling
1129          compatibility.
1130     -    Fix problem with externally modified files on disk where the
1131          user would get stuck in a loop answering "really edit the
1132          buffer?"  Thanks to Bryan Fink for a detailed report.
1133     -    Font lock fix for URLs with underscores.
1134     -    Escape shell commands to handle filenames with spaces, etc.
1135          Thanks to Marcin Kasperski for a patch.
1136     -    Use `:slant` instead of unsupported `:italic` in font spec.
1137     -    Fix typo in `paragraph-fill` regexp.
1139 # Markdown Mode 1.8.1
1141 *August 15, 2011*
1143 Version 1.8.1 is a bugfix version which addresses some minor issues in
1144 version 1.8.
1146 *   New features:
1148     -    Wiki link features now support aliased or piped wiki links of
1149          the form `[[PageName|link text]]`.
1151 *   Bug fixes:
1153     -    Fixed an issue, reported by Werner Dittmann, where the
1154          default indentation position would be skipped over when
1155          `auto-fill-mode` was on.  This meant that when writing a
1156          normal paragraph, for example, the line would wrap to column
1157          4 instead of column 1.
1158     -    Require the `cl` package for `multiple-value-bind`.  Thanks
1159          to Werner Dittman for noticing this.
1160     -    Remove a leftover debug print message which would announce
1161          "ENTER" in the minibuffer when the enter key was pressed.
1163 # Markdown Mode 1.8
1165 *August 12, 2011*
1167 *   New features:
1169     -   Add support for following wiki links in a buffer, either with
1170         <kbd>C-c C-f</kbd> or, optionally, <kbd>RET</kbd>, when the
1171         point is at a wiki link.
1172     -   Support Markdown processors which do not accept input from
1173         stdin (i.e, Python-Markdown) by adding the
1174         `markdown-command-needs-filename` custom option.  Thanks to
1175         Jeremiah Dodds for a patch.
1176     -   GitHub-Flavored Markdown mode (`gfm-mode`) turns on
1177         `longlines-mode` and `auto-fill-mode`.  Thanks to Edward
1178         O'Connor for the patch.
1179     -   Add outline-mode-like keybindings for fast outline navigation
1180         of atx-style headers (see the updated documentation for
1181         details).
1182     -   Arbitrary content may to be added to the `<head>` block during
1183         HTML output to allow for flexible local customizations.  See
1184         `markdown-xhtml-header-content`.
1185     -   New HTML export options: export to a file with
1186         <kbd>C-c C-c e</kbd> or export to a file and view with
1187         <kbd>C-c C-c v</kbd>.
1188     -   Support Markdown processors which produce standalone output
1189         (i.e., complete HTML documents).  If this is detected, by
1190         matching `markdown-xhtml-standalone-regexp` in the first five
1191         lines of output, then omit the `markdown-mode` header and
1192         footer.  Thanks to Philippe Ivaldi for this and the previous
1193         HTML-output-related patches.
1194     -   Customizable wiki link following behavior using
1195         `markdown-follow-wiki-link-on-enter`.
1196     -   Quick navigation to the previous and next wiki links using
1197         <kbd>M-p</kbd> and <kbd>M-n</kbd>.
1198     -   Wiki links to non-existent files (missing links) are
1199         highlighted differently.  Based on functionality from
1200         `wiki-mode` by Alex Schroeder.  Thanks to Eric Merritt for
1201         patches.
1203 *   Improvements:
1205     -   Improve syntax highlighting of preformatted text blocks to
1206         better distinguish them from list items with hanging
1207         indentation and nested list items.
1208     -   Match italic and bold text and inline code fragments across
1209         line breaks, within a single block, but prevent them from
1210         matching across blocks.
1211     -   Generally improve multi-line font lock by extending the search
1212         region to include full blocks.
1213     -   Make indentation work when the previous line is not indented.
1214     -   Set tab width to 4, the natural tab width for Markdown
1215         documents.
1216     -   Stop announcing "TAB" in the minibuffer when tab is pressed.
1217     -   Use `html-mode` for viewing Markdown output.
1218     -   Ensure Markdown output buffer is always raised, even when the
1219         output is short.
1220     -   Make sure horizontal rules inserted by <kbd>C-c -</kbd>
1221         (`markdown-insert-hr`) are surrounded by blank lines.
1222     -   Added an `autoload` cookie.  Thanks to Peter S. Galbraith for
1223         the patch.
1224     -   Support a customizable horizontal rule string
1225         `markdown-hr-string`.  This replaces the previous but less
1226         flexible custom option `markdown-hr-length`, which has been
1227         removed.
1228     -   Followed wiki links are opened using `markdown-mode`.
1230 *   Bug fixes:
1232     -   Fixed an issue, reported by Joost Kremners, where for
1233         multi-line lists, the position of the list marker was not
1234         being added to the list of possible indentation levels.
1235     -   Avoid a problem where indentation positions were getting
1236         skipped over when tab cycling.
1237     -   Fixed an issue when column 0 is the natural automatic
1238         indentation stop.
1239     -   Prevent infinite loops in blockquote (<kbd>C-c C-s b</kbd>)
1240         and preformatted (<kbd>C-c C-s p</kbd>) block insertion while
1241         at the beginning or end of the buffer.
1243 # Markdown Mode 1.7
1245 *October 1, 2009*
1247   * New features:
1249     -    Support filling of list items.
1250     -    Allow customization of font-lock faces (thanks to intrigeri
1251          for the patch).
1252     -    Automatic indentation when pressing enter or tab (with
1253          cycling upon subsequent tab presses) (thanks to Bryan Kyle).
1254     -    Generate real XHTML for previewing (thanks to Hilko Bengen
1255          for the patch).  This fixes [Debian bug #490865](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=490865).  The CSS
1256          stylesheet for XHTML output is customizable via
1257          `markdown-css-path` (thanks to Ankit Solanki for the patch).
1258     -    Better URL matching (protocols are customizable through
1259          `markdown-uri-types`).
1260     -    LaTeX syntax highlighting can be enabled or disabled using
1261          the customize system (`markdown-enable-math`).
1262     -    Support for HTML comments (font lock, `comment-dwim`, etc.).
1263     -    Support filling of definition lists (thanks to Peter Williams
1264          for the patch).
1266 *   Improvements:
1268     -    Add support level 5 and 6 atx-style headers (thanks to Alec
1269          Resnick for the report).
1270     -    Fill-paragraph no longer breaks lines inside of square
1271          brackets (thanks to Peter Williams for the patch).
1273 *   Bug fixes:
1275     -    Fixed several font lock issues.
1276     -    Fixed a bug where pressing enter did nothing in
1277          longlines-mode (thanks to Ankit Solanki for the patch).
1278     -    Fixed a problem where Emacs snapshot would hang during
1279          `markdown-enter` and `markdown-cycle` (thanks to Alec Resnick
1280          for the report).
1281     -    Fixed an issue with auto-fill-mode and markdown-mode's
1282          indentation (thanks to Joost Kremers for the report and
1283          analysis).
1285 # Markdown Mode 1.6
1287 *June 4, 2008*
1289 *   **Breaking changes:**
1291     -    Rename `blockquote-region` to `markdown-blockquote-region` in
1292          accordance with the Emacs major mode coding conventions.
1293     -    Several new keybindings.
1294     -    Reverted to using colors instead of bold, italic, and
1295          fixed-width faces.
1297 *   New features:
1299     -    Implemented org-mode style visibility cycling.
1300     -    Support outline minor mode.
1301     -    Undefined reference checking (via `C-c C-c c`, using code by
1302          Dmitry Dzhus).
1303     -    Wiki links: syntax highlighting and element insertion
1304          (`C-c C-a w`).
1305     -    Allow syntax highlighting faces to be customized.
1306     -    Insertion of preformatted text sections (`C-c C-s p`).
1307     -    Font locking for inline URIs and email addresses.
1308     -    Markdown mode menu (thanks to Greg Bognar for the initial
1309          code).
1311 *   Improvements:
1313     -    Markdown customize group moved to `wp` (word processing).
1314     -    Derive from `text-mode` instead of `fundamental-mode`.
1315     -    Properly prefix regex definitions and `wrap-or-insert`
1316          function.
1318 *   Bug fixes:
1320     -    Highlight wrapped inline link definitions (thanks to Blake
1321          Winton).
1322     -    Fix adjacent wiki link font lock bug.
1323     -    Support escaping of backticks.
1324     -    Many other small font lock tweaks.
1325     -    Don't check for `transient-mark-mode` in
1326          `markdown-blockquote-region`.  This fixes Debian bug #456592
1327          (thanks to Daniel Burrows for the report).
1328     -    Apply Greg Bognar's fix for `markdown` with an active region.
1329     -    Don't use the kill ring to store wrapped text.
1331 # Markdown Mode 1.5
1333 *October 11, 2007*
1335 Version 1.5 is a major revision compared to previous releases.  The
1336 functionality has not changed very much, all of the keybindings are
1337 the same, but it is internally quite different.
1339 Most of the changes involve syntax highlighting.  The regular
1340 expressions have been significantly improved and the corresponding
1341 font lock faces have been tweaked (hopefully for the better, but feel
1342 free to customize them).  Various other small bugs have been fixed and
1343 the documentation and website have been updated.
1345 The two changes in functionality, both of which are optional, are
1346 syntax highlighting for embedded mathematics via LaTeX-like
1347 expressions, and highlighting for bracketed wiki links.
1349  [itex]: http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html
1351 # Markdown Mode 1.4
1353 *June 29, 2007*
1355 Version 1.4 includes a small fix to the regular expression syntax to
1356 fix the Emacs 21 "Invalid escape character syntax." error.  Thanks to
1357 Edward O'Connor for the fix.
1359 # Markdown Mode 1.3
1361 *June 5, 2007*
1363 Version 1.3 provides syntax highlighting, insertion commands for all
1364 basic HTML elements, and preview commands for viewing the resulting
1365 HTML in a new buffer of an external browser.
1367 # Markdown Mode 1.2
1369 *May 25, 2007*
1371 Version 1.2 adds element insertion commands and keys for links,
1372 horizontal rules, headers, inline code, and bold and italic text.
1374 Added element insertion commands and keys for links, horizontal rules, headers, inline code, and bold and italic text.
1376 # Markdown Mode 1.1
1378 *May 24, 2007*
1380 Version 1.1 is the initial release of Markdown Mode for Emacs, a major
1381 mode to edit Markdown files in Emacs.  This version provides basic
1382 syntax highlighting and element insertion commands for Markdown files.