From 1ce36dd88b33fb54a436d21cb06d880a09cba37b Mon Sep 17 00:00:00 2001 From: Kevin Gibbons Date: Wed, 26 Jun 2024 17:09:34 -0700 Subject: [PATCH] add support for opengraph tags (#598) --- ecma-logo.png | Bin 0 -> 5984 bytes package.json | 2 +- spec/index.html | 2 + src/Spec.ts | 36 ++++++++++++++++++ src/ecmarkup.ts | 1 + .../generated-reference/copyright.html | 2 +- .../proposal-copyright.html | 2 +- .../generated-reference/shortname.html | 2 +- test/baselines/generated-reference/test.html | 4 +- test/baselines/generated-reference/title.html | 2 +- test/baselines/sources/title.html | 1 + 11 files changed, 48 insertions(+), 6 deletions(-) create mode 100644 ecma-logo.png diff --git a/ecma-logo.png b/ecma-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..b65fb8738a2e753e432f7dac1b45f090b1a9611d GIT binary patch literal 5984 zcmZ`-1z40_(_TtILPA17SXy#vVQF^h4v~=Vt|gXkL_$hpK`8<025FI$M!Ka#X_glL z_5Hs8{od=3b6xYCc_!{TGv~>P)=-ltcu4gS000muDnPYR^E`@_a2}wJOMXh}005f4 z9R#AG2!Q}K++D2g9IXI=XNgV;ZOUC5k9*Vws5Fl;-U!3`%{7a)>}B0bpT5yxntVfN zh-fID?Ug6#ARk|vn^TmR?yg|K3AK>!>5zIAfo~suA!u)a?A*LvUUhAv$&uB0!VwJ^ zh;%AUu01&!DB%>(fBHLtNKS8xll*1MW7(tf;nAk3FZJMFZ>w3~BWKqiXPjR)e#htT zt@uy;9NOfHI}5Ycu_z?K>FOS67#2Px!d3ylxlE`%IOg3h>!U!bu)GJhGapR6v5&t@ z6wY!wLO$S56RNMIzCMd5zIG3|EZ(Uzmx>}Y-OUEVtb+vp;?yA^!)_!Tc6L+`$1xcW-iY(IX zBrg97om{VYIOes{T&Wx^fIdn4>Y{C}xt=r!iTl}I0xfXPG=IuR-yKzJT`N6BYgJVM zJBr5vphejMFi{*Dil|To0AM6V0FooIU=X7Air|9}S3?n+NnaHp*4(j})w7=VRrl z54Cebl?N3=;<

U*`Wy@t=VIaMb&cBOkBuKRy4U`JbLIJgnRyE>5V3Fp2+c%)g!g zsrCC|I~!*1T7?(3GoYuBm@Ttj3!4*up%QtQxurPWHk|N%idDcbYwURd9poDsT3k8Szg@5(*&eE779+&Ept;g{yBAFPL7$BHt&ITHGd7V7Ev+OrQ9trwZq6L$L2^wkEiDaXL!|A&&*9CJl>R4A-bT9}4gf$@${PUTo}cf4)nS@-XMK(1Zy>Guu~ zA3b|SvWxU(H*QO6KS@(30>^?nSI;o${GlByNcoyM$M&S_SZdX}m&X2rWl-v+bivY? z-2#g2ZEUrHooC0QdUEDDy&LldlOG9DjkG8ThTHx zG0D+qF>0Fqf&2x?Q( zb#VCtpCkz_lf2m-oyvpGRx`5hT#hFjuS23KKlZn{6_=J4QFygJR;mryYV$1*H4faA zmzYr5>aQZ=s<^}Nna(CV<#o7Qk`e8h?Y*m0`CJ#3ba(qR_@L`xWk0u};XL^JwKA;w zV=TA7!CK;wnfF*lqnBT}0~wF;K@uUYm`d7UrO&HK-Mh?XxHsL@^fWw$jsOioN`M)r z*_Eov6#JyO=Q+Lv3g?2VBC}{fs>i7{|5FkFAsd8<2j1@L{-fC2&8@9Vm7v=l z+_#r+CGWy>L|F5GEnc-$8Kq9_er)uLI7B0Bh;-1XD%6$NBZ)H-yEosTN~@3MBkahL zCUqf8)N78p=HJ$qOe<%xQ4dmC{?Ps)EadLaa3yDxBemHoz~?6H>|o(0T)K9i;2RNrt#UrvX!?#|U|9*8!;gf#J zJ~d@>q44(PemBF#FI@c`pel%{&QDSq-kfY&`hZDS$lx*j0-O?$D-&83KXgObHCoXjcP!F;5cMBFxjTa^8XJ@y-Gil3Sv?!X|sp9xMhn0a+lxk&(*!}Zy2cu@yPaVx^X~x{glL-{q?I5>^D>2PFXpEGgo(KnG;}jS+8;6N=;eEw)^S|Yq{3nW>`^HZKn#zc zrDj@M@V7UutOKhH>_eqPU7^glnHh0GAy9O$LQpReu&sbc^DL+5( z%Qn70Rxhsi+{rEV>Y05^TVj&3BE`xZoJf`i$7Yh@0jl9lQ-?`yb%}kh zc^BcKE3HZ5;Bzo+2WKCC^OT*9jlfpZV7q5F-?(c7XDZ&d^(8TNShXZE-t=nfxbg$D z_ok)PXk7u(qz(S21jAS{+q)As-^{Bq7pH9}tpW0+c|Au$9F9anu;+;rMC#WHM8kW| zBZM5|=m&DiqVx^6ZO5ng1>P42`PEb^llV-@)b+Wg6XCY4{2BPIZ3Br3J$=Ru$V=}^ zRs$E)kKkS2<;u&&)0LtTwUrym-}S5phsi9ueIcK9syQTkomUxo_EIH-o&#rnXd2zf z%2pI`AE9Hz9i}DyZ!&@vt%Wk}22)#b9lY|H4WbL97CteIKZwqH7f#713f-r;9grHY6+GvTi)8QkHY`y;dtEiYT$)>#~C zo(6)L+1L^roZ8YFoR?$<)40g`;u;qHI-=a5B*UPTc2a!AkmYb&jJbn&hFWs6JiIlW(8giTT|v{ER|fOm3lJNqKf_OPy)_mVSeE*`O*T zjy`TfVT4>)-a@`Uo5tep!La_|wCaT!F1bndvvMy0scv<{w2+c=nlnkL>~CP^!PLfx z=*uzhyJN#}Beu@hjR9GmDQ=>LQAH3eiR*Sf9?A)#0mHp^kO`Z@Iv zt+)NcInZ1V=Suwvt|k_=n~d_;Md+Vv$N^e_SN<;jOM~W8atL{Tf7bm>wmt~mXiZ_YKeGE<9{&x z4Z)S>izlS%-y?ng=(}KQ1AL?UlpKVw*{0}hOvv@BE_gtx%`YJ| zf>(nA^J1yv-G|$OH1QI{I-iiScv@l_jlionz)XXz#;WlVcxyon%tt0PBTd$m*5+2? zdWVRs!(uoc5q6TNDKND@!uCzT^n+YFgn%!{6%Xn??y;H| zk%B<1HF7ojq34e))Z(>{`ng>EjIq2CWTv8uKea8KE}fKg!WD_L{(efUKs`DGP78W3 z)oqFuNLwwu|xnV^)o)(YnLi-#iqR$Te^>M zve!gJIL&_kK>PcI5%KQ1CZ6x@u{;|uuV(F5gkN2*K17iF87I`^WX*G-+2(RcFKl-B zP+^!Xe5pidf5z*^6&CY$lfe?o^Di?k z?|zAYM_y=MeBJNj-r?&e(&#hHJ^OV4Ak?j<0lbVP6e=A10YF+;k_}??Haz4Vr51>H zqO%xpZ3>tC4CsIrXO*y*ekyEM`4R&bDXOHYG8~iyW+^B7~ncOk6W!8^U%>bH-BiVCXW@lG7({nG z)i-PCCg{L6?br(XKBfs7xfD2dkCARY3auyJ^7fgF0PR!!B4~gAeb8HPMa`R|sv%M} zze)EkJw2wVTyv@zeR~&KNOf&IjhITT*~+b#F=5r|dATif8bJ0gv+mD#wf#;fK}abF zdc6Rj3ImTm5l#%RWlb<+C4?b|4E5P=K+iUqh;xbhMHt2w=2QBAh3nRylY8iS#aV-7 zFS|EKM%aL)E|*T9#}!hIIhdK5zSqU(u8Zm6S9~hZgLsLFuYV+_02YKF{5?z>lM352ZNranyOOnO)<$#c4&u;$LeG3$F{Ps=)0$CJ*n9}K|LIsX?G?D~ z%So4ukmxFxB@bLx>>8F+Qdi8cOVMc*4wC%y1QrNc^P6Rcco^b^*b>1QV6QM*W|v#7 z^N;4x@{GzWh@Rp=9S--HGM9RTy!NWkG{mwyW8U*^Jdh!ZTTi5YuLhSy13w`qb^6T7 zm_4JsaRCn_B8-B-z7(8B8b8#U(F48ak62PzZ1WA9JvQ5J*05e4qIs0}&WMYZ2-ETd zV#ILYCk%a2z0M2233g~sveuacv;2rLUb1JeK+jjvR-XTU#7GQ8`@ps(`8hPW%vSxl z=3QvN!c0FUJq;zj zN(1r3Zp^J@&%suWHrt-gbJ3yaYe61z$2HrSJvXb&k-h(0i>GWWl0d5;ZWHU<{HTYh z;0RAjm)n>gj9lgKD?XMZdd6AQ-B-z3=ANCW&42V=E(9tqxUz@IY<~7XF|3dSntnAgV z_3(vK7V)wxDZYY$8F)8fxFVuo1VR2R-s8y}zcm2?vHn8%DRO3@rGB;dizh{UVm&7K zrXKNdJQuY96>}_FTWaBLG?4_lZkiaW+R(?8sq9P;ky@WmMG4&l5c`*Ca)QWunc8)M zXvE~BMjKoQhp=U-`bFb%D2XZuQ(rX=KJ)t#>BcLas^O+D^9OB=*xe@Z9vkO5(OJdO z47}}~v0{tIeQKJAdUZoww31s}6c5WIMKTel{d1H4VSE$(-D85{f^i5#!|q!(uC_{^ z2&f`^pLY^z)QFh5#3nmBBMaqLnLRoeZe03Mmkz#ck&Rk`GmF4hvcYSnf907@XZBiq zxJ$n8%j~j0#&B>h>m5%DHP_DTXVj-f(Aw=Q0hk)TILEAQ$W;aJS)c6{8S<3mpTGA zitvofxK+z4^q&lvkpA)SbNnAeNajdH4IX~}O(Yom_$wq6Qk%^o0{T9^@&g-lGz3Bh z`GnPfONxOeR_$>W9S48y#W$3*`p8xlrj>rcOQ!|Z-1-{>EhSFT#7Xv);7!Kcyb{$S{i()Vi)`cG!e!KYPnGKRe+pD{7zu4>&QuqNs& z+V3RHh9g+|x}b>dqXcX7t5`Qy*`cSjR=l7Yi032tW!;AQBFxxBrbh%9*caHZ@JC3`Jg@SlJPko<| zmlinI4uOg}$ z6+#b;qYqhS(pJQjkwLYbm@X}?qoqty{UWT$WEEy&99%TTx`ZFe8O(o7qsb}N_})Q* zOsF1|OsKkbDh_5Os(EB8{7r`>B!MUaiiazaq0c}>iF!%>AE39AlT+KIT@}Hq0Mt;F LRfAT@n1=orvRfZ~ literal 0 HcmV?d00001 diff --git a/package.json b/package.json index 799f30ef..9b5d1cee 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "scripts": { "build": "tsc -sourceMap -declarationMap", "build-release": "tsc", - "build-spec": "mkdir -p docs && node bin/ecmarkup.js spec/index.html docs/index.html --assets-dir=docs", + "build-spec": "mkdir -p docs && node bin/ecmarkup.js spec/index.html docs/index.html --assets-dir=docs && cp ecma-logo.png docs/", "prepack": "safe-publish-latest && npm run build-release", "format-spec": "node bin/emu-format.js --write spec/index.html", "test": "mocha", diff --git a/spec/index.html b/spec/index.html index 9aafb1d5..ded4e569 100644 --- a/spec/index.html +++ b/spec/index.html @@ -3,6 +3,7 @@ Ecmarkup 

 repository: https://github.com/tc39/ecmarkup
+desription: An HTML superset/Markdown subset source format for ECMAScript and related specifications
 copyright: false
 markEffects: true
@@ -69,6 +70,7 @@

Options

`version`Document version, for example "6<sup>th</sup> Edition" (which renders like "6th Edition") or "Draft 1". `date`Timestamp of document rendering, used for various pieces of boilerplate. Defaults to the value of the `SOURCE_DATE_EPOCH` environment variable (as a number of second since the POSIX epoch) if it exists, otherwise to the current date and time. `shortname`Document shortname, for example "ECMA-262". If present and `status` is "draft", `version` defaults to "Draft shortname". + `description`Brief description to be used for link previews in social media and the like. `location`URL of this document. Used in conjunction with the biblio file to support inbound references from other documents. `copyright`Emit copyright and software license information. Boolean, default true. `contributors`Contributors to this specification, i.e. those who own the copyright. If your proposal includes text from any Ecma specification, this should include "Ecma International". diff --git a/src/Spec.ts b/src/Spec.ts index a3865d07..ea2c8c5f 100644 --- a/src/Spec.ts +++ b/src/Spec.ts @@ -1438,6 +1438,42 @@ ${this.opts.multipage ? `
  • Navigate to/from multipagem this.doc.head.prepend(node) + : (node: HTMLMetaElement) => metas[metas.length - 1].after(node); + if (!metas.some(n => n.getAttribute('property') === 'og:description')) { + const description = ( + this.opts.description ?? + (this.doc.querySelector('emu-intro') ?? this.doc.querySelector('emu-clause'))?.textContent + ) + ?.slice(0, 300) + .trim(); + if (description) { + const meta = this.doc.createElement('meta'); + meta.setAttribute('property', 'og:description'); + meta.setAttribute('content', description); + insertMetaTag(meta); + } + } + if (!metas.some(n => n.getAttribute('property') === 'og:title')) { + const title = this.opts.title ?? this.doc.querySelector('title')?.textContent; + if (title) { + const meta = this.doc.createElement('meta'); + meta.setAttribute('property', 'og:title'); + meta.setAttribute('content', title); + insertMetaTag(meta); + } + } + if (!metas.some(n => n.getAttribute('property') === 'og:image')) { + const meta = this.doc.createElement('meta'); + meta.setAttribute('property', 'og:image'); + meta.setAttribute('content', 'https://tc39.es/ecmarkup/ecma-logo.png'); + insertMetaTag(meta); + } } private buildCopyrightBoilerplate() { diff --git a/src/ecmarkup.ts b/src/ecmarkup.ts index dace1fff..5ee57920 100644 --- a/src/ecmarkup.ts +++ b/src/ecmarkup.ts @@ -27,6 +27,7 @@ export interface Options { version?: string; title?: string; shortname?: string; + description?: string; stage?: string | null; copyright?: boolean; date?: Date; diff --git a/test/baselines/generated-reference/copyright.html b/test/baselines/generated-reference/copyright.html index 01eb7e25..934ecd7e 100644 --- a/test/baselines/generated-reference/copyright.html +++ b/test/baselines/generated-reference/copyright.html @@ -1,5 +1,5 @@ -test title!
    +test title!
    • Toggle shortcuts help?
    • Toggle "can call user code" annotationsu
      • diff --git a/test/baselines/generated-reference/proposal-copyright.html b/test/baselines/generated-reference/proposal-copyright.html index fd61877d..19a5d0c4 100644 --- a/test/baselines/generated-reference/proposal-copyright.html +++ b/test/baselines/generated-reference/proposal-copyright.html @@ -1,5 +1,5 @@ -test title!
      +test title!
      • Toggle shortcuts help?
      • Toggle "can call user code" annotationsu
        • diff --git a/test/baselines/generated-reference/shortname.html b/test/baselines/generated-reference/shortname.html index 7191e309..7e842d50 100644 --- a/test/baselines/generated-reference/shortname.html +++ b/test/baselines/generated-reference/shortname.html @@ -1,5 +1,5 @@ -test title!
        +test title!
        • Toggle shortcuts help?
        • Toggle "can call user code" annotationsu
          • diff --git a/test/baselines/generated-reference/test.html b/test/baselines/generated-reference/test.html index 226d38f8..73d682e7 100644 --- a/test/baselines/generated-reference/test.html +++ b/test/baselines/generated-reference/test.html @@ -1,5 +1,7 @@ - + Ecmarkup Test Document
          diff --git a/test/baselines/generated-reference/title.html b/test/baselines/generated-reference/title.html index 994acf7e..47262a40 100644 --- a/test/baselines/generated-reference/title.html +++ b/test/baselines/generated-reference/title.html @@ -1,5 +1,5 @@ -test title!
          +test title!
          • Toggle shortcuts help?
          • Toggle "can call user code" annotationsu
            • diff --git a/test/baselines/sources/title.html b/test/baselines/sources/title.html index 2ce8aec2..df9ac95e 100644 --- a/test/baselines/sources/title.html +++ b/test/baselines/sources/title.html @@ -1,5 +1,6 @@ 
             title:     test title!
+description: a test document
 status:    draft
 version:   Draft 1
 toc:       false