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