update README, vim docs and add an example

sotte · Oct 10, 2021 · 3b4e176 · 3b4e176
1 parent 2e174e4
commit 3b4e176
Showing 5 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,10 @@ Markdown files are rendered a bit more fancifully. Be sure to read the help file
 
 ![presenting.vim Markdown demo](examples/FancyMarkdown.gif)
 
+Markdown image links where handled by converting them into ascii.
+
+![image2ascii markdown example](examples/image2ascii_demo.png)
+
 ## Installation
 
 Use [pathogen][3] or [vundle][4] to install presenting.vim.

diff --git a/doc/presenting.txt b/doc/presenting.txt
@@ -153,7 +153,23 @@ These fonts can be changed with the the following variables: >
 More information about figlets can be found at https://figlet.org and the
 interactive website http://patorjk.com/software/taag can be used to test out
 the different fonts.
+------------------------------------------------------------------------------
+                                                         *presenting_image2ascii*
+
+Note: Currently, this applies only to Markdown files.
+
+Markdown image embeddings can also been rendered into ascii by a tool called
+image2ascii. This is on by default, and can be turned off by setting >
+  :let g:presenting_image2ascii = 0
+>
+
+You can append `=WIDTHxHEIGHT` after the URL of the graphic file to resize the
+image. Do not forget the space before the `=`: >
+  ![alt text](./image.png =55x35)
+>
 
+More information about image2ascii can be found at
+https://github.com/qeesung/image2ascii
 ==============================================================================
 ISSUES                                                       *presenting-issues*
 

diff --git a/examples/1200px-Vimlogo.png b/examples/1200px-Vimlogo.png
diff --git a/examples/PresentingDemo.markdown b/examples/PresentingDemo.markdown
@@ -120,6 +120,20 @@ function Factorial(n)
 endfunction
 ```
 
+# Images
+
+If [image2ascii](https://github.com/qeesung/image2ascii) is installed and enabled markdown image links are converted to ascii and displayed in the presentation buffer.
+You can append `=WIDTHxHEIGHT` after the URL of the graphic file to resize the image. Do not forget the space before the `=`
+
+```bash
+![vim logo](./1200px-Vimlogo.png =55x35)
+```
+
+Results into:
+
+![vim logo](./1200px-Vimlogo.png =55x35)
+
+
 # The End
 
 

diff --git a/examples/image2ascii_demo.png b/examples/image2ascii_demo.png