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