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