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