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