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