From 5557e6282c0556d024330369f230267c219d8455 Mon Sep 17 00:00:00 2001
From: Thomas Hunter II <me@thomashunter.name>
Date: Mon, 12 Nov 2018 22:14:03 -0800
Subject: [PATCH] feat(image): optionally add image captions from alt tags

---
 dist/showdown.js                              | Bin 173544 -> 173882 bytes
 dist/showdown.js.map                          | Bin 488985 -> 490068 bytes
 dist/showdown.min.js                          | Bin 81125 -> 81368 bytes
 dist/showdown.min.js.map                      | Bin 91924 -> 92119 bytes
 src/options.js                                |   5 +++++
 src/subParsers/makehtml/images.js             |  13 ++++++++++++-
 .../cases/features/extractImageCaptions.html  |   2 ++
 .../cases/features/extractImageCaptions.md    |   3 +++
 .../functional/makehtml/testsuite.features.js |   2 ++
 9 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 test/functional/makehtml/cases/features/extractImageCaptions.html
 create mode 100644 test/functional/makehtml/cases/features/extractImageCaptions.md

diff --git a/dist/showdown.js b/dist/showdown.js
index 36c74cd802fbe1595b2e6bacaae1c6faa19313ce..5482a2a4aaf083a17b3a12f45a15c2eb075358e4 100644
GIT binary patch
delta 1151
zcmbVKT}TvB6y_XVcb%2|2{S6|qUrjRJFAxIs*68atc6*LCfLumj_Yi?V>`20NLhwN
zLR47XhoB#*Am~MXxM45VTSXRRzLkOxMLlQ_^%6w0bFV@@HVn*nzw_O5&YbUjc`Z%P
zNY}P(@RXH!Doe^drB$RzmI``ek)WY!k%GdZ@!G6S6CIJHwaRHD8VDNx{y<1+3=G7>
z;{kiAr-}1KjR#1e&mcx1L;^YqkRX?l9xY0YUWH4h?j_wyo2t!vl{e+69eYbNlTl_b
zQlQI5Ap<wlyP05P4H@v$Mt#S@!RpsTvjy#JJR8;}adt8nwmLYRFNXO9>n{5!!)~zH
z;kH;bLX>_jtdgMCt>{FJ7#b&Zi4>VH*{A9T(Rzp;8yL`{hSDv<UeaqA1G-n1L#ojm
zJK+v${j%Px4R&jTk+8lB<w5nNDmTSz#8b-BipH(SXlo;6u;-<ahrG+Ba#)|hVcJf3
zD&VXa+6654fjf~4!VTcGi)m~EiQV?Y2>&fsxEFrlYABH|bebdbx4>`U<Z_OAj<mu%
zCr`Df3!-)lQuAs$dmn^jd|33(8dKUCf-7lUx-<wSqL;iOkR^0g)2n@$x&L3=b&{VS
zH@eMSi9#|Y5$lO6ddxJxxR$tTdel%Xs`y;hR_v@~eO3hQz$lzSdb1BxhyN?JSSz24
z6tA>lB3F%UmR*hU(uAy3jkgsS{M8qI;)WEu{N1!_@e)jk!KOWgRQ6&FW+Zm~CXCjx
ztT}KIG0&gSDHik5FF0(OYo~RMkVDU<gOgSK275B|*>O%7mYs}?4rXrlf*`)G#q-=;
zc6lR8>6UM7avQD@?!WY471DYy=Fo66I+>>&KLbB|ci;z($||tKLhNw`hDG>@AMLEJ
z5+8`O!;6*7OyuP0m{x-Y0#5sIS->~-cotETc;dS4Xk*4MY);|lc|S_*TPqqO=g2|4
z!3$R%!c&4=YB3AXwqX$Hy`$)2$J(*p!Ay9;B68X8<4A4nlY$q0?8JRM0`%Df%>M&V
COJWHC

delta 707
zcmX|7O-Phc6y@HUpI(0X8<l)HA7hQ<$LNg1<jgQQjD;H`HIoF*(yXk6385cps7(|$
z88kHUTI3=@+Eg;l;zHCSp+yE}LA8l?Q7wvypq15q(wo(J=ic+qz2`n&5?@}58y+(p
zX=({Ig+nbd%MKdCf9y<p^z?~SX@6tJD8#eQ;-KqX1sJ)wS^U1~;dU^JciOVAz#yLi
z*Bp$6D%j#=T-*%3iko$?Rq^;X2)G%K2H^7=Fl2iiJTxAH4q(EcgYuEUwCpZNCv}Ix
zgRD(Qz+&yq++YpOMq!@cv^N0<70xH2buHtkolxy!3m5_~)po)Z`_b%fSYd<JqC7MJ
zZhFxLf7B$F`RH2@EU#zT(*tmx|5Ee_Osbu@>7k`D$a6wEJPAA0Aen)vpy(Aii<G(w
zi^}(PhJ}sO@IkP^A>ne0G5a1GEXKlb7*WZqR$v(2h6viWux$A(0^VC?C}{34xYu$2
zfg9iH@WkPt@OdPkua2gxaY4oC+K5vs+iLNbiK0>yvl%z2^mZ8A)k3*`^wRYR{#1sF
z$h)ohR=;mYv0sZSV|Y@FXeN&LHId^9jA_;L1b)>GT5dysX-I7ff0RgI7hXU#gq-NZ
zdRd-82fgXQ&N6M2?8S@PMt<CfdELnO;Y6virw3isydOuoLcIKObqK}=vW9WszpS2S
YMo_A|M#k_`l9A?cNHuHjp^ta?2P>PuZvX%Q

diff --git a/dist/showdown.js.map b/dist/showdown.js.map
index 00aa3de48e279c994436552ae3fcaeba52cc9bfa..d25a535bd08d689ab0841a3e79163c670d7d6c4d 100644
GIT binary patch
delta 885
zcmbVI-Ahwp7-#SKXgisnu`|n&@J8WhdDev#D$X^Bm6nMa6$^Hn`#4K?*3Mazx^UKo
zbP<^^_M}keomVn3I1z!n2%=#hBMl;gU3BTiqW*x+oJJR2L@zuK56|=C_wmkd)~^4o
z&3qS#i@yZvw@4uTO^!@836SnV0yx(ZH|?n;{lg65eKe7(yGV_YG5{QOc_|K@XXrgE
zckQhXlXz!U)K^8*t96JUq$(j>K>Wis#6iJ>%;cWCf>h4iNw!Lu;VFS+mO0>Gq8doQ
zK@3b;jP`mO?MI@QObj~oID-n5>8L(nLF|1<cT;8<%%Qz-Zj)jllQ(hjbqrMi|Iy(0
z-$pi)wKCwyP*xb9LmY7qFa*08@L#5D$WnCo%vl4+`;C_VW)fhHrUc-9M)Pl&I8qpA
zwpQe6NPz4dGNWVNWI5=7tV9b?w9-a~8%WUcEGkmq&lxoT?gK7<Mpf{>pJt$FqpPN`
za3s^tSccs0p~F3HcMn)osJiUB<m1aTWMSLgZcpn8G9Pu6jFWeHyDmOPPiZuAax%Yw
zjH2}X0{zJ<1jn?56wpqMO5vbKifghGQ{h3DJ^~+>XvXO+pRruJV`)UgniR&8iX|K<
zqj5+{U@a0XLtx@L-7vYhLhFkw4C8{hi={_`qe@i90cAL-VmYQMcx$2hVz{YPxKCC!
ztc0+djK`IP798FNwBd-R#nm=Z49i+1d9@{=jEZVRNewHhSXBKziYfV;EP6{SDjayi
z9@4viFdG++*SGs(hJf+p5N=S);adKd7}wR6!kss6jrbN^?`3V~j*uKqCW4({EiyJ%
zO&Zyo_3G2?Bh>OAbd4pt?Jw)B$IUx(##G-S{&|CVFDqEKc02O>Ap3%~Pv-hqJ=eFZ
GzwsAe#5Oqq

delta 289
zcmcceMRw*J*$p2>CQFKxPoAL7HT^&c3)gf99wyf5=lxkYHg}4dN--KX?>E@K-+=MR
zmFWVfnD{1N&}IXv1*?DA!+dl41}2dDSxj8hW$!V$Oz-)?Y%u-9IcCY}Ic6;U+ZEWE
z6q%=gQDl;xyda!wvcpEM=?VfswE+@90>s)rfs1KJ-}DE+fcytJK%)d^G3792xK7@f
zCN+IQG!xh40&cG93uJ)O2_it{2WBz-VxG=@jgf2exl5wcc@mj5CQtC--?o4$lZC0w
zeY#>Glfv}%?M$rg6P7RmG4u8bOIS7vw%^;vvi;sRRyO<TZ_cx-O%J@zRyh4!J{#Ni
fx^JxK!?y47Wt+-0U8<N(vYjcAZ97vSdypmo`TuES

diff --git a/dist/showdown.min.js b/dist/showdown.min.js
index a298817d3e1de74330369cdeb6c6f228cf8c9c4a..5a400d5d983fc22d165de6d1d987744fed42bc52 100644
GIT binary patch
delta 400
zcmaF*ljX*5mI-oP21dFD7P>|ThL#&OcvuBeD@uwIlS@2v6Vp?j6AMZv-)B)UaD@me
zWP(H$5_3uvN)po*5{nfQ6_SB!GV}8k((;QGN-|O*N+vJl5Z-LcT62&&S0`oi+_Mss
z&m5B!Pti*cEy^j@Nwx*DLNZHoQj2v;ZBsV?Ikt_FMJLfVadP67usG|o#3F?ZTO}py
zqSTVoqCACMJ#;q#?JHJOD^gR_$k4V`vPsKKFD**7Q_|D{a@B1zbJG=yi;``X)U^|}
z)s;Zb1+j~OY;~Q<mM8xQ>kwlk)MIu^K%Gi9`anzIA|QJpLNI%4Cx6&3%A%2Kn=*Of
yMFn9{Fcs@1r2+#bRY@mR2NVj8OT;$MKGn;_2v#!L^DI9&a2~8z*<61%B_9A_%Z^C^

delta 191
zcmccdo8{?GmI-oPMkcz32D(NDh87z&cvv?tW34^NT%?mb`N0c`$#%yj#dG!2LyK~X
zb&_p?tdPu-oYZ2SQrq0kdB?XgPOdx2E~svknVYUqT$F69q^_-zXqz~>@mZLprnb70
zLSjw{NU#XVR<|xnEh#O^Q<!|`<p1dhIT(c}JDg@?%$=+_Q+~4TIrho9r@6rP3jP<{
eJmGXN6I@CFEPQc>%H)^l_%=743(IHX<pKZ}qekig

diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map
index 4889b775f5371ab74cbd48586ea35380bbf4a643..8203460b7dfcfffbcda203d9252011a49c6baa0e 100644
GIT binary patch
delta 2250
zcmah~OKcle6xFn(O&~uJnxZy>ra(btBs>1Z$@0GEnW=FS<M<axO(e&0{f}eENo-3f
zVu28d1=XtvyRt!m*ig+PC>vUZ4GTc5Kx#`$7eH4amK74*`)sG<5Q&X7@4kEP=iGCj
zuYcF|<M&-(3@d}FTD6i$R(-`pI>i%fRdYZ&H`iBY0P9TUz}Hw*Tn&v5gw!J1O43$f
z^I`&R5!H@1hqN`=g7k~2TWG6G+a_BUAB0AG<7yHhMbVa5#6B7lY5*WehS{s)&(LUp
zQcVG*C1@qX$kdxs697r_S;z^0_+lSkM*w1E2^T~?d~q<#)I26DN?eYuiqFFrxAROb
zp|LEDt89%?@}#N(UqM?OAfe{HSjj3={Qxs+4753HtIV-uPQllB^%zVE19V_8SQhhO
zI>cnyW(%`zO_V;G2sxcZ(3k{ySnZfZ6GszmFsu>clqT9Z2H;@U%C@ncEoPx}oHdE8
zquU_^b=`uAAOr_?NVoHtBzB(#K$O{$GVG)+5_cQ3ZOM|xk~=s<sbCp^SiGq*Pa9;x
zl#Wv7V(JV)fDqGD#{kwl0o&T#gheQ}V-V@-BV|o?_LAZMl}yn}81;`M3;{%_tht;8
zz}g~9A7w1fJDM+8Ky6G>5+>e_U3eL_i1PGvYJSEmzctc-WRt5t&{pXed|Tp&*m>UI
zB=0ETFQn|8hMyt`&u}l<d|Wk<Lg@ynx;*(YP7(}^gR2-=7q)p<f5uCGDg5C!mKEjs
z(LprP#IPF7P~~y)ReVwWGym#ffvM}3i=vo{gXZD1U~T6l(TE2Fv>M0m564*O3>uLO
z+eT@a;?v3M<5FsD!;4stcNX`6Yp7EWvU#crBDKe!4Q3}k%)N!1%7BeP2F@}7I+VER
zzj8@@bfq_mb|f}{)8lTfL@|u847VoZ1;(0`wcI*R{;Y;A#ZXfQ%q6f82<J4!a$Qn?
z2o(d1Bi(JJa4xz|H1peoSnrgKA5gQXs0?oxfV?*YViicgjz8er5aYiN3H#D1@zdhX
zfi|#ClVBzD!=-Od9*)chfgGPOOUth-%DA|dd`@wh2g%Q(JryrK(mYx+ukD3;PDX0_
z&SbaZG|zoqJlnH5O%#@xOT2&Q%qwm#-*{YU(#(XDlfpx}amh;%Z}G7WRrN{p+dEy#
zldCSW^CAl6?%ijHGtHyROMEmmsj4g&xA)Eq{pTSudGC|Kigcmp8gXt`H2=7_q!_5M
zG!{6{(vp~9>x^C~aHqwZ!cC*s8ju@fw&iW(BpyDW7uOG7?3v>9C~-Y2ZXaY%OEvPa
zxOH$z#O^11TE5Y|xqtr+Wx!ev__Ai;!TuAcv?(py;Nr`_yh&csr7r5ty$NC3F}942
zd6>`bXp(~5&=zbl7xspY7kGpw7r`|!7N}7CM46=Kh|(F_-?&bn5p>paUh|#bx)ej3
z{oimYfGmqPk;GP|ohJdtG>Naw!s6QRFPs?H#V?OWc1F%9&%YD{yWY?$m(?It^tf8|
zLRn8Z@O|)szrmdN5d^0get1LM(sP=pMrRv3mVGd$hnkK?rRBJ4#MSz1P&6W~i)!nl
zfEO+XdBc44@NLgis2ckFU1w?c?t7!kgJ*`O{Kx~xeM->m=+$!Uyg8x#-R<;a;XF{@
qeaoZVIQz7l7M3rQhaXwymmNEOLFK}3G@yK}G;cNQ?JnM)9{v~W@0v6K

delta 2126
zcmZuyOK)3M5Y|-*<V6yZlJW>u6BVfBTl`F%Ea#ki?HDI@{k8)MauVx0b{r?Mlh_uO
z1)DBGI!Iwx2?-%~M0b&@QjrP>i4Cwp2t-QL4J}>p7nnJ=lN-w$+h=CJd3@)a<KKVj
z`RwPOZ^jh!x-uGhvB&^QOy$5gSVG*2P7Fs?2ijcHR%a=(fVQ~0kG7h$?Xg919Gw_U
zs;dB5LawZc{@BD|S`7h&$#7#$c+rqivjBz!t%>Q_)&2~?D)|?4Lc}HqvuYe5NrqTn
zd>5M>#@GVZDN0D5i3hP!@qB!wvCh;I+P9^BlWj68y{hWK*Rc0AKt?TS*vAG_g8&O^
z67&cr+2#OcPWiX^P8UoG6P&|fvURLekacpb(!w;Xg^bQZ*wqYzY!c*UdtC}mcNQu$
z>=Dw`TB6zo;9}O!8aU1_vyfS5s-&`pVW$k#d=^X`A^WW;BHY=fh$CPD5M_A3+c*g}
zN0c#l8`H2<G0=66GY3<#4Ztt-RM}J;WWkg=DMN8B0E7rJ@9hF8p9eJbh=-kNWwr~#
znD1z7`ur^RE|{W~Fq(gcsZoG9wH3+nGmSOcA~QM}!%MdgpSOV8n4*=iH24#0fYt^-
zQuCx>A8k!&o0D>boOoH#<ZqoOj#s!E=m&ihzW@Te;<eQ4yvhlf0Q`h(jgv64gyA`^
zkuAVgKjxHSklmN3ASPM`Kjx9;L^b6ZvP(}EgSnj<;$CWE1Why$ZVgtb@T7Q_x;>I-
zYT05eh>z27ZHm+4wF5K679RYdSGgg_XkKq#JWG!&9P=!R>|$_eN2A_k%_=L4Zx_dh
z_RdUoR-*~c3-28&L$eyP;m3;zfe(t}aOrLF^!>qAG$U0ZyedAW7pYNyOp=4M;qalE
zCI_vsbElx8W1mSBgC8Op+M!rZM=bYAE>EE%wKU$_Mv4!YJPMV!UH8h=A$1*<ljH5$
zI8QSdHh@(6Xuv?3iw`odh>7LH;Wny9l(M3Evi#G9Q|<#0%5#r-cjcy{)J5OgWyNJ)
zTl+fEx24fL%o9cP&wJ56C2GF&!xxu)719ho*e-WdDx4G>%{%4jVKmZvjtfjG@Zhn-
zi?3_6;+r<d{_0V@8y<PfMP|q!_->-aP<)6@BlDV@+c5(+?a_#%x-O+-h^@Qh;**D?
z;-llQMz)$zd~7jpiWSV6hs%l|Rb*iAPG)QN)jDGoR&ZOaS==;wtpPdn-)Ke8a(eA~
zYF!-veRaUg=~3c7!^H(W85N&C8WHwKTEEmEkJ+4UbGfetOst!OC%2SgYi|%R%+DWx
z|J;~=mM$CuwYqFAih9siA|mq-T%kvIQ=_d*+i<IphB$_nSXINpH(0>zebS>0?6O5X
z&OyD#4<5`bFZa#^b#K?j$&Z&0{u@``cryt$y{_-fsbO&HX|<?<L(jMzw8FtUbK{RN
z<isCO@95KdUiadjhGEN>R=2U5FWL<B@3aD|=%~F5`@VR~QE55$(BWaQ>of2Fd)qsJ
z5}^OcGP8M(LX*nlix<5?lA~Qiog=|Cv?F-198}&qD0r3MdYwVKvry@1ZbrFt=_NO9
i8(*QgAP&gq90$LKl`BWD-c-I+nqJ-NJwopbWB&s_<!`kB

diff --git a/src/options.js b/src/options.js
index afefab0..0f6cb95 100644
--- a/src/options.js
+++ b/src/options.js
@@ -46,6 +46,11 @@ function getDefaultOpts (simple) {
       describe: 'Turn on/off image dimension parsing',
       type: 'boolean'
     },
+    extractImageCaptions: {
+      defaultValue: false,
+      describe: 'Extract image alt tag as a caption for the image',
+      type: 'boolean'
+    },
     simplifiedAutoLink: {
       defaultValue: false,
       describe: 'Turn on/off GFM autolink style',
diff --git a/src/subParsers/makehtml/images.js b/src/subParsers/makehtml/images.js
index 63d9f09..1b41c92 100644
--- a/src/subParsers/makehtml/images.js
+++ b/src/subParsers/makehtml/images.js
@@ -59,7 +59,13 @@ showdown.subParser('makehtml.images', function (text, options, globals) {
       .replace(showdown.helper.regexes.asteriskDashTildeAndColon, showdown.helper.escapeCharactersCallback);
     //url = showdown.helper.escapeCharacters(url, '*_', false);
     url = url.replace(showdown.helper.regexes.asteriskDashTildeAndColon, showdown.helper.escapeCharactersCallback);
-    var result = '<img src="' + url + '" alt="' + altText + '"';
+    var result = '';
+
+    if (options.extractImageCaptions && altText) {
+      result += '<figure>';
+    }
+
+    result += '<img src="' + url + '" alt="' + altText + '"';
 
     if (title && showdown.helper.isString(title)) {
       title = title
@@ -79,6 +85,11 @@ showdown.subParser('makehtml.images', function (text, options, globals) {
 
     result += ' />';
 
+    if (options.extractImageCaptions && altText) {
+      result += '<figcaption>' + altText + '</figcaption>';
+      result += '</figure>';
+    }
+
     return result;
   }
 
diff --git a/test/functional/makehtml/cases/features/extractImageCaptions.html b/test/functional/makehtml/cases/features/extractImageCaptions.html
new file mode 100644
index 0000000..531c508
--- /dev/null
+++ b/test/functional/makehtml/cases/features/extractImageCaptions.html
@@ -0,0 +1,2 @@
+<p><figure><img src="./image.png" alt="This is a caption" /><figcaption>This is a caption</figcaption></figure></p>
+<p><img src="./no-caption.png" alt="" /></p>
diff --git a/test/functional/makehtml/cases/features/extractImageCaptions.md b/test/functional/makehtml/cases/features/extractImageCaptions.md
new file mode 100644
index 0000000..1506636
--- /dev/null
+++ b/test/functional/makehtml/cases/features/extractImageCaptions.md
@@ -0,0 +1,3 @@
+![This is a caption](./image.png)
+
+![](./no-caption.png)
diff --git a/test/functional/makehtml/testsuite.features.js b/test/functional/makehtml/testsuite.features.js
index 4affe1c..082a300 100644
--- a/test/functional/makehtml/testsuite.features.js
+++ b/test/functional/makehtml/testsuite.features.js
@@ -95,6 +95,8 @@ describe('makeHtml() features testsuite', function () {
         converter = new showdown.Converter({openLinksInNewWindow: true});
       } else if (testsuite[i].name === '#355.simplifiedAutoLink-URLs-inside-parenthesis-followed-by-another-character-are-not-parsed-correctly') {
         converter = new showdown.Converter({simplifiedAutoLink: true});
+      } else if (testsuite[i].name === 'extractImageCaptions') {
+        converter = new showdown.Converter({extractImageCaptions: true});
       } else {
         converter = new showdown.Converter();
       }