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