Document markdown-display-remote-images

Author: jrblevin

CHANGES.md

@@ -57,7 +57,8 @@
         table insertion.  ([GH-369][])
     -   Add `markdown-kill-outline` and `markdown-kill-block`
         functions.
-    -   Added options for viewing remote images.  ([GH-378][])
+    -   Added `markdown-display-remote-images` for viewing remote
+        images.  Thanks to Sean Allread for the patch.  ([GH-378][])
 
 *   Improvements:
 
@@ -176,6 +177,7 @@
   [gh-340]: https://github.com/jrblevin/markdown-mode/issues/340
   [gh-350]: https://github.com/jrblevin/markdown-mode/pull/350
   [gh-369]: https://github.com/jrblevin/markdown-mode/pull/369
+  [gh-378]: https://github.com/jrblevin/markdown-mode/pull/378
 
 # Markdown Mode 2.3
 

README.md

@@ -226,14 +226,18 @@ can obtain a list of all keybindings by pressing <kbd>C-c C-h</kbd>.
     added to the end of the reference definition and will be used
     to populate the title attribute when converted to HTML.
 
-    Local images associated with image links may be displayed
+    Images associated with image links may be displayed
     inline in the buffer by pressing <kbd>C-c C-x C-i</kbd>
     (`markdown-toggle-inline-images`).  This is a toggle command, so
-    pressing this once again will remove inline images.  Large
-    images may be scaled down to fit in the buffer using
-    `markdown-max-image-size`, a cons cell of the form
-    `(max-width . max-height)`.  Resizing requires Emacs to be
-    built with ImageMagick support.
+    pressing this once again will remove inline images.
+    By default, only local images are displayed.  However, remote
+    images will also be downloaded and displayed if
+    `markdown-display-remote-images` is non-nil.
+
+    Large images may be scaled down to fit in the buffer using
+    `markdown-max-image-size`, a cons cell of the form `(max-width
+    . max-height)`.  Resizing requires Emacs to be built with
+    ImageMagick support.
 
   * Text Styles: <kbd>C-c C-s</kbd>