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