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