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