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