CHANGES.md

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