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