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