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