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