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