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