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