vitepress-linkcards 2.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 No bug
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,133 @@
+<h1 align="center">
+vitepress-linkcard
+</h1>
+
+<div align="center">
+
+**A VitePress plugin to generate a pretty linkcard with OGP.**
+
+You can see: [A blog generated with this plugin](https://asumoranda.com/posts/10-vitepress-linkcard.html) | [Docs by TypeDoc](https://asumo-1xts.github.io/vitepress-linkcard/)
+
+[![NPM Version](https://img.shields.io/npm/v/vitepress-linkcard?style=flat&logo=npm&logoColor=white&label=npmjs&color=%23CB3837)](https://www.npmjs.com/package/vitepress-linkcard)
+[![VitePress](https://img.shields.io/badge/For_VitePress-v1_|_v2-%235C73E7?logo=vitepress&logoColor=white)](https://vuejs.github.io/vitepress/v1]/)
+[![NPM License](https://img.shields.io/npm/l/vitepress-linkcard)](/LICENSE)
+
+[![Yarn](https://img.shields.io/badge/Built_with_Yarn-v4.9.2-%232C8EBB?logo=yarn&logoColor=white)](https://yarnpkg.com/)
+[![Oxc](https://img.shields.io/badge/Oxc-%2300F7F1?logo=oxc&logoColor=white&label=Lint%20and%20Format%20with&labelColor=gray)](https://oxc.rs/)
+
+<img src="https://github.com/asumo-1xts/vitepress-linkcard/blob/main/.github/screen.gif?raw=true" width=90% alt="How it shows" />
+
+This plugin was forked from [markdown-it-link-to-card](https://github.com/luckrya/markdown-it-link-to-card).
+
+</div>
+
+## Getting started
+
+### Install
+
+```shell
+npm i -D vitepress-linkcard     # npm
+yarn add -D vitepress-linkcard  # yarn
+pnpm add -D vitepress-linkcard  # pnpm
+```
+
+### Usage
+
+#### `docs/.vitepress/config.ts`
+
+```ts
+import { defineConfig } from 'vitepress'
+import { linkToCardPlugin } from 'vitepress-linkcard'
+import type { LinkToCardPluginOptions } from 'vitepress-linkcard'
+
+export default defineConfig({
+  // ...
+  markdown: {
+    config: (md) => {
+      md.use<LinkToCardPluginOptions>(linkToCardPlugin, {
+        // target: "_self" // if needed
+      })
+    }
+  }
+  // ...
+})
+```
+
+#### `*.md`
+
+Generates a linkcard when `@:` appended.
+
+```md
+[example](@:https://example.com)
+```
+
+## Supported options
+
+### Target
+
+As shown in [Usage](#usage), you can specify the target window in which to open a link.
+
+- `_blank` **(default)**
+- `_self`
+- `_top`
+- `_parent`
+
+### Color theme
+
+You can customize:
+
+| Property                      | **default**           |
+| :---------------------------- | --------------------- |
+| Border color                  | `var(--vp-c-bg)`      |
+| Background color              | `var(--vp-c-bg-soft)` |
+| Border color when hovered     | none                  |
+| Background color when hovered | none                  |
+
+#### `docs/.vitepress/theme/custom.css`
+
+```css
+/* For example: like "Features" in VitePress */
+
+.vitepress-linkcard-container {
+  border-color: #00000000 !important;
+  background-color: var(--vp-c-bg-soft) !important;
+}
+
+.vitepress-linkcard-container:hover {
+  border-color: var(--vp-c-brand-1) !important;
+  background-color: var(--vp-c-bg-soft) !important;
+}
+```
+
+#### `docs/.vitepress/theme/index.ts`
+
+```ts
+import DefaultTheme from 'vitepress/theme-without-fonts'
+import type { Theme as ThemeConfig } from 'vitepress'
+import './custom.css'
+
+const Theme: ThemeConfig = {
+  extends: DefaultTheme
+}
+
+export default {
+  ...Theme
+}
+```
+
+## Other specifications
+
+### `.linkcard_cache.json`
+
+It is generated automatically in `docs/` and cache all the parsed metadata.
+
+You can move it to root dir if needed.
+
+### Special handling for `github.com`
+
+When the domain is `github.com`, trimming is performed as shown in the following example to avoid duplication of the title and description.
+
+|        | Title                                                                                     | Description                                                                                                                                 |
+| ------ | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| Before | GitHub - asumo-1xts/vitepress-linkcard: A VitePress plugin to generate a pretty linkcard. | A VitePress plugin to generate a pretty linkcard. Contribute to asumo-1xts/vitepress-linkcard development by creating an account on GitHub. |
+| After  | asumo-1xts/vitepress-linkcard                                                             | A VitePress plugin to generate a pretty linkcard.                                                                                           |

package/dist/.cjs.min.js

@@ -0,0 +1,23 @@
+/*!
+  * vitepress-linkcards v2.2.2
+  * (c) 2022 - 2026 luckrya
+  * Released under the MIT License.
+  */
+Object.defineProperty(exports,"__esModule",{value:!0});var e=require("url"),t=require("child_process"),r=require("fs"),n=require("http"),o=require("https"),i=require("node:fs");function a(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var s,c,l=a(e),u=a(t),f=a(r),d=a(n),p=a(o),h=a(i);function v(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=Array(t);r<t;r++)n[r]=e[r];return n}function g(e,t){for(var r=0;r<t.length;r++){var n=t[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(e,m(n.key),n)}}function y(e,t,r){return(t=m(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function b(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,n)}return r}function E(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?b(Object(r),!0).forEach(function(t){y(e,t,r[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):b(Object(r)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))})}return e}function w(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,o,i,a,s=[],c=!0,l=!1;try{if(i=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;c=!1}else for(;!(c=(n=i.call(r)).done)&&(s.push(n.value),s.length!==t);c=!0);}catch(e){l=!0,o=e}finally{try{if(!c&&null!=r.return&&(a=r.return(),Object(a)!==a))return}finally{if(l)throw o}}return s}}(e,t)||function(e,t){if(e){if("string"==typeof e)return v(e,t);var r={}.toString.call(e).slice(8,-1);return"Object"===r&&e.constructor&&(r=e.constructor.name),"Map"===r||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?v(e,t):void 0}}
+/*!
+  * @luckrya/utility v0.1.0
+  * (c) 2022 - 2022 Y.R
+  * Released under the MIT License.
+  */(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function m(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(c=s||(s={})).Array="[object Array]",c.Object="[object Object]",c.Function="[object Function]",c.Number="[object Number]",c.String="[object String]",c.Boolean="[object Boolean]",c.Undefined="[object Undefined]",c.Null="[object Null]",c.Error="[object Error]";var x=function(e){return Object.prototype.toString.call(e)===s.String},S=function(e){return Object.prototype.toString.call(e)===s.Function},O="undefined"!=typeof window,k=function(){var e,t="".concat(process.cwd(),"/docs/.linkcard_cache.json"),r="".concat(process.cwd(),"/.linkcard_cache.json");if(h.default.existsSync(t))e=t;else if(h.default.existsSync(r))e=r;else{e=t;h.default.writeFileSync(e,JSON.stringify({"https://example.com/":{description:"Example Website",logo:"https://example.com/example.png",title:"Example Title"}},null,2))}return e},N=function(){return function(e,t,r){return t&&g(e.prototype,t),r&&g(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e}(function e(){!function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,e)},[{key:"setFile",value:function(e){var t=e,r=this.readFile();r&&(t=Object.assign(r,t)),h.default.writeFileSync(k(),JSON.stringify(t)),function(){var e=k(),t=h.default.readFileSync(e,"utf-8").trim();if(t){var r=JSON.parse(t),n=JSON.stringify(r,null,2)+"\n";h.default.writeFileSync(e,n)}}()}},{key:"readFile",value:function(){var e=h.default.readFileSync(k(),"utf-8"),t=JSON.parse(e);if(function(e){return Object.prototype.toString.call(e)===s.Object}(t))return t}},{key:"has",value:function(e){return!!this.get(e)}},{key:"get",value:function(e){var t=this.readFile();return null==t?void 0:t[e]}},{key:"set",value:function(e,t){this.setFile(y({},e,t))}}])}(),T=new N;function j(e){return'style="'.concat(function(e){return Object.entries(e).map(function(e){var t,r=w(e,2),n=r[0],o=r[1];if(n&&o)return"".concat((t=n,t.replace(/\B([A-Z])/g,"-$1").toLowerCase()),": ").concat(o,";")}).filter(Boolean).join(" ")}(e),'"')}var C=function(e){return{"-webkit-box-orient":"vertical","-webkit-line-clamp":e,display:"-webkit-box",hyphens:"auto",lineClamp:e,overflow:"hidden",overflowWrap:"anywhere",textOverflow:"ellipsis",wordBreak:"break-word"}},R=function(e,t){var r,n,o={rel:'rel="noopener noreferrer"',target:'target="'.concat(t.target,'"'),href:'href="'.concat(t.href,'"'),title:'title="'.concat(t.linkTitle,'"')},i=function(e){return e.replace(/&amp;/g,"&").replace(/&lt;/g,"<").replace(/&gt;/g,">").replace(/&quot;/g,'"').replace(/&#039;/g,"'")},a={a:j({color:"unset !important",display:"block",width:"100%",textDecoration:"none"}),container:j({display:"flex",alignItems:"center",flexWrap:"wrap",gap:"10px",borderRadius:"12px",border:"1px solid var(--vp-c-bg)",backgroundColor:"var(--vp-c-bg-soft)",boxSizing:"border-box",width:"100%",height:"130px",transition:"all 0.25s"}),img:j({borderRadius:"0px 12px 12px 0px",maxWidth:"40%",height:"128px",flexShrink:0,objectFit:"contain",overflow:"hidden"}),texts:j({flex:"1 1 0%",minWidth:"0"}),title:j(E(E({},C(2)),{},{opacity:1,fontSize:"16px",lineHeight:"22px",margin:"0 16px 8px 16px",fontWeight:"bold"})),domain:j(E(E({},C(1)),{},{opacity:1,fontSize:"12px",lineHeight:"16px",margin:"8px 16px 8px 16px",textDecoration:"underline"})),description:j(E(E({},C(2)),{},{opacity:.8,fontSize:"12px",lineHeight:"16px",margin:"8px 16px 0px 16px"}))},s=t.href||"",c=new URL(s).origin.replace(/^https?:\/\//,"").replace(/^www\./,"")||"Unknown domain",l=e.title,u=e.description;"github.com"==c?(l=(null===(r=e.title)||void 0===r?void 0:r.split(":")[0].replace("GitHub - ",""))||"No title",u=(null===(n=u)||void 0===n?void 0:n.replace(" - ".concat(l),"").replace("Contribute to ".concat(l," development by creating an account on GitHub."),""))||""):(l=e.title||"No title",u=e.description||"");return'<span style="display:block;">\n  <a '.concat(o.rel," ").concat(o.target," ").concat(o.href," ").concat(o.title," ").concat(a.a,'>\n    <span class="vitepress-linkcard-container" ').concat(a.container,">\n      <span ").concat(a.texts,">\n        <span ").concat(a.title,">\n          ").concat(i(l),"\n        </span>\n        <span ").concat(a.domain,">\n          ").concat(i(c),"\n        </span>\n        <span ").concat(a.description,">\n          ").concat(i(u),'\n        </span>\n      </span>\n      <img src="').concat(null==e?void 0:e.logo,'" ').concat(a.img,"/>\n    </span>\n  </a>\n</span>")};function D(e){return new URL(e)}var A="https://resources.whatwg.org/logo-url.svg",L=/(<[A-Za-z]+\s*[^>]*>(.*)<\/[A-Za-z]+>)/,q=/content=["|']([^>]*)["|']/,P=/href=["|']([^>]*)["|']/,H=/(<title\s*[^>]*>(.*)<\/title>)/g,F=function(e){return new RegExp("<".concat(arguments.length>1&&void 0!==arguments[1]?arguments[1]:"meta","\\s[^>]*\\w+=['|\"]([a-zA-Z]|:|\\s)*").concat(e,"['|\"][^>]*\\/?>"))};function _(e){var t,r=e.match(F("title"));if(null!=r&&r.length){var n=r[0].match(q);n&&x(n[1])&&(t=n[1])}else{var o=e.match(H);if(null!=o&&o.length){var i=o[0].match(L);i&&x(i[2])&&(t=i[2])}}return t}function I(e){var t,r=e.match(F("description"));if(null!=r&&r.length){var n=r[0].match(q);n&&x(n[1])&&(t=n[1])}return t}function U(e){var t,r=e.match(F("image"));if(null!=r&&r.length){var n=r[0].match(q);n&&x(n[1])&&(t=n[1])}else{var o=e.match(F("icon","link"));if(null!=o&&o.length){var i=o[0].match(P);i&&x(i[1])&&(t=i[1])}}return t}function M(e,t){var r,n,o,i={title:_(e),description:I(e),logo:(r=U(e),r?D(r)?r:"".concat(null===(n=D(t))||void 0===n?void 0:n.origin).concat("/".concat(r).replace(/\/\//g,"/")):A)};return o=i,Object.values(o).filter(function(e){return x(e)}).length?i:null}function B(e){return e&&e.__esModule&&Object.prototype.hasOwnProperty.call(e,"default")?e.default:e}var J,G={};
+/**
+ * Wrapper for built-in http.js to emulate the browser XMLHttpRequest object.
+ *
+ * This can be used with JS designed for browsers to improve reuse of code and
+ * allow the use of existing libraries.
+ *
+ * Usage: include("XMLHttpRequest.js") and use XMLHttpRequest per W3C specs.
+ *
+ * @author Dan DeFelippi <dan@driverdan.com>
+ * @contributor David Ellis <d.f.ellis@ieee.org>
+ * @license MIT
+ */var z=function(){if(J)return G;J=1;var e=l.default,t=u.default.spawn,r=f.default;return G.XMLHttpRequest=function(){var n,o,i=this,a=d.default,s=p.default,c={},l=!1,u={"User-Agent":"node-XMLHttpRequest",Accept:"*/*"},f={},h={},v=["accept-charset","accept-encoding","access-control-request-headers","access-control-request-method","connection","content-length","content-transfer-encoding","cookie","cookie2","date","expect","host","keep-alive","origin","referer","te","trailer","transfer-encoding","upgrade","via"],g=["TRACE","TRACK","CONNECT"],y=!1,b=!1,E={};this.UNSENT=0,this.OPENED=1,this.HEADERS_RECEIVED=2,this.LOADING=3,this.DONE=4,this.readyState=this.UNSENT,this.onreadystatechange=null,this.responseText="",this.responseXML="",this.status=null,this.statusText=null,this.withCredentials=!1;this.open=function(e,t,r,n,o){if(this.abort(),b=!1,!function(e){return e&&-1===g.indexOf(e)}(e))throw new Error("SecurityError: Request method not allowed");c={method:e,url:t.toString(),async:"boolean"!=typeof r||r,user:n||null,password:o||null},w(this.OPENED)},this.setDisableHeaderCheck=function(e){l=e},this.setRequestHeader=function(e,t){if(this.readyState!==this.OPENED)throw new Error("INVALID_STATE_ERR: setRequestHeader can only be called when state is OPEN");if(function(e){return l||e&&-1===v.indexOf(e.toLowerCase())}(e)){if(y)throw new Error("INVALID_STATE_ERR: send flag is true");e=h[e.toLowerCase()]||e,h[e.toLowerCase()]=e,f[e]=f[e]?f[e]+", "+t:t}else console.warn('Refused to set unsafe header "'+e+'"')},this.getResponseHeader=function(e){return"string"==typeof e&&this.readyState>this.OPENED&&o&&o.headers&&o.headers[e.toLowerCase()]&&!b?o.headers[e.toLowerCase()]:null},this.getAllResponseHeaders=function(){if(this.readyState<this.HEADERS_RECEIVED||b)return"";var e="";for(var t in o.headers)"set-cookie"!==t&&"set-cookie2"!==t&&(e+=t+": "+o.headers[t]+"\r\n");return e.substr(0,e.length-2)},this.getRequestHeader=function(e){return"string"==typeof e&&h[e.toLowerCase()]?f[h[e.toLowerCase()]]:""},this.send=function(l){if(this.readyState!==this.OPENED)throw new Error("INVALID_STATE_ERR: connection must be opened before send() is called");if(y)throw new Error("INVALID_STATE_ERR: send has already been called");var d,p=!1,v=!1,g=e.parse(c.url);switch(g.protocol){case"https:":p=!0;case"http:":d=g.hostname;break;case"file:":v=!0;break;case void 0:case null:case"":d="localhost";break;default:throw new Error("Protocol not supported.")}if(v){if("GET"!==c.method)throw new Error("XMLHttpRequest: Only GET method is supported");if(c.async)r.readFile(g.pathname,"utf8",function(e,t){e?i.handleError(e):(i.status=200,i.responseText=t,w(i.DONE))});else try{this.responseText=r.readFileSync(g.pathname,"utf8"),this.status=200,w(i.DONE)}catch(e){this.handleError(e)}}else{var E=g.port||(p?443:80),m=g.pathname+(g.search?g.search:"");for(var x in u)h[x.toLowerCase()]||(f[x]=u[x]);if(f.Host=d,p&&443===E||80===E||(f.Host+=":"+g.port),c.user){void 0===c.password&&(c.password="");var S=new Buffer(c.user+":"+c.password);f.Authorization="Basic "+S.toString("base64")}"GET"===c.method||"HEAD"===c.method?l=null:l?(f["Content-Length"]=Buffer.isBuffer(l)?l.length:Buffer.byteLength(l),f["Content-Type"]||(f["Content-Type"]="text/plain;charset=UTF-8")):"POST"===c.method&&(f["Content-Length"]=0);var O={host:d,port:E,path:m,method:c.method,headers:f,agent:!1,withCredentials:i.withCredentials};if(b=!1,c.async){var k=p?s.request:a.request;y=!0,i.dispatchEvent("readystatechange");var N=function(e){i.handleError(e)};n=k(O,function t(r){if(301!==(o=r).statusCode&&302!==o.statusCode&&303!==o.statusCode&&307!==o.statusCode)o.setEncoding("utf8"),w(i.HEADERS_RECEIVED),i.status=o.statusCode,o.on("data",function(e){e&&(i.responseText+=e),y&&w(i.LOADING)}),o.on("end",function(){y&&(w(i.DONE),y=!1)}),o.on("error",function(e){i.handleError(e)});else{c.url=o.headers.location;var a=e.parse(c.url);d=a.hostname;var s={hostname:a.hostname,port:a.port,path:a.path,method:303===o.statusCode?"GET":c.method,headers:f,withCredentials:i.withCredentials};(n=k(s,t).on("error",N)).end()}}).on("error",N),l&&n.write(l),n.end(),i.dispatchEvent("loadstart")}else{var T=".node-xmlhttprequest-content-"+process.pid,j=".node-xmlhttprequest-sync-"+process.pid;r.writeFileSync(j,"","utf8");for(var C="var http = require('http'), https = require('https'), fs = require('fs');var doRequest = http"+(p?"s":"")+".request;var options = "+JSON.stringify(O)+";var responseText = '';var req = doRequest(options, function(response) {response.setEncoding('utf8');response.on('data', function(chunk) {  responseText += chunk;});response.on('end', function() {fs.writeFileSync('"+T+"', JSON.stringify({err: null, data: {statusCode: response.statusCode, headers: response.headers, text: responseText}}), 'utf8');fs.unlinkSync('"+j+"');});response.on('error', function(error) {fs.writeFileSync('"+T+"', JSON.stringify({err: error}), 'utf8');fs.unlinkSync('"+j+"');});}).on('error', function(error) {fs.writeFileSync('"+T+"', JSON.stringify({err: error}), 'utf8');fs.unlinkSync('"+j+"');});"+(l?"req.write('"+JSON.stringify(l).slice(1,-1).replace(/'/g,"\\'")+"');":"")+"req.end();",R=t(process.argv[0],["-e",C]);r.existsSync(j););var D=JSON.parse(r.readFileSync(T,"utf8"));R.stdin.end(),r.unlinkSync(T),D.err?i.handleError(D.err):(o=D.data,i.status=D.data.statusCode,i.responseText=D.data.text,w(i.DONE))}}},this.handleError=function(e){this.status=0,this.statusText=e,this.responseText=e.stack,b=!0,w(this.DONE),this.dispatchEvent("error")},this.abort=function(){n&&(n.abort(),n=null),f=u,this.status=0,this.responseText="",this.responseXML="",b=!0,this.readyState===this.UNSENT||this.readyState===this.OPENED&&!y||this.readyState===this.DONE||(y=!1,w(this.DONE)),this.readyState=this.UNSENT,this.dispatchEvent("abort")},this.addEventListener=function(e,t){e in E||(E[e]=[]),E[e].push(t)},this.removeEventListener=function(e,t){e in E&&(E[e]=E[e].filter(function(e){return e!==t}))},this.dispatchEvent=function(e){if("function"==typeof i["on"+e]&&i["on"+e](),e in E)for(var t=0,r=E[e].length;t<r;t++)E[e][t].call(i)};var w=function(e){e!=i.LOADING&&i.readyState===e||(i.readyState=e,(c.async||i.readyState<i.OPENED||i.readyState===i.DONE)&&i.dispatchEvent("readystatechange"),i.readyState!==i.DONE||b||(i.dispatchEvent("load"),i.dispatchEvent("loadend")))}},G}(),X=B(z),V=new Map,W=O?window.XMLHttpRequest:X.XMLHttpRequest;function Z(e){if(V.has(e))return V.get(e);var t;try{var r=new W;r.open("GET",e,!1),r.setRequestHeader("Content-Type","text/html"),r.send(),200===r.status&&r.responseText&&(t=r.responseText,V.set(e,r.responseText))}catch(e){console.error("【XHR Error】：".concat(e instanceof Error?e.message:"get remote URL resource exception!"))}return t}var $=new Map;exports.generateCard=function(e,t){return new Promise(function(r){var n=Z(e);if(n){var o=M(n,e);if(o){var i={linkTitle:t.linkTitle,target:t.target||"_blank",classPrefix:t.classPrefix},a=R(o,E(E({},i),{},{href:e})),s={url:e,data:o,options:i,dom:a};$.set(e,s),r(s)}}})},exports.linkToCardPlugin=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};function r(e){var r,n=function(e){if(T.has(e))return T.get(e);var t=null,r=Z(e);return r&&(t=M(r,e))&&T.set(e,t),t}(e.url);if(n){!function(e,t){e.forEach(function(e,r){r!==t&&(e.hidden=!0)})}(e.tokens,e.i);var o={href:e.url,linkTitle:(r=e.tokens,r.map(function(e){var t=e.hidden,r=e.content;return t?r:""}).filter(Boolean).join("")),target:t.target||"_blank",classPrefix:t.classPrefix};return S(t.render)?t.render(n,o):R(n,o)}}e.renderer.renderInline=function(t,r,n){for(var o="",i=0;i<t.length;i++){var a=t[i],s=e.renderer.rules[a.type];a.hidden?o+="":S(s)?o+=s(t,i,r,n,e.renderer):o+=e.renderer.renderToken(t,i,r)}return o},e.renderer.rules.link_open=function(e,t,n,o,i){var a,s=e[t],c="a"===s.tag&&"link_open"===s.type,l=function(e){var t=new RegExp("^(".concat("@",":)([a-zA-Z0-9]+.*)")),r=null==e?void 0:e.match(t);return{isCardLink:!!r,url:null==r?void 0:r[2]}}(null===(a=s.attrs)||void 0===a||null===(a=a.filter(function(e){return e.includes("href")})[0])||void 0===a?void 0:a[1]),u=l.url,f=l.isCardLink;if(c&&f&&u){var d=r({url:u,tokens:e,i:t});if(d)return d}return i.renderToken(e,t,n)}};

package/dist/.esm.min.js

@@ -0,0 +1,23 @@
+/*!
+  * vitepress-linkcards v2.2.2
+  * (c) 2022 - 2026 luckrya
+  * Released under the MIT License.
+  */
+import e from"url";import t from"child_process";import r from"fs";import n from"http";import o from"https";import i from"node:fs";function a(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=Array(t);r<t;r++)n[r]=e[r];return n}function s(e,t){for(var r=0;r<t.length;r++){var n=t[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(e,p(n.key),n)}}function c(e,t,r){return(t=p(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,n)}return r}function u(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?l(Object(r),!0).forEach(function(t){c(e,t,r[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):l(Object(r)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))})}return e}function f(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,o,i,a,s=[],c=!0,l=!1;try{if(i=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;c=!1}else for(;!(c=(n=i.call(r)).done)&&(s.push(n.value),s.length!==t);c=!0);}catch(e){l=!0,o=e}finally{try{if(!c&&null!=r.return&&(a=r.return(),Object(a)!==a))return}finally{if(l)throw o}}return s}}(e,t)||function(e,t){if(e){if("string"==typeof e)return a(e,t);var r={}.toString.call(e).slice(8,-1);return"Object"===r&&e.constructor&&(r=e.constructor.name),"Map"===r||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?a(e,t):void 0}}
+/*!
+  * @luckrya/utility v0.1.0
+  * (c) 2022 - 2022 Y.R
+  * Released under the MIT License.
+  */(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function p(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!=typeof n)return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}var d,h;(h=d||(d={})).Array="[object Array]",h.Object="[object Object]",h.Function="[object Function]",h.Number="[object Number]",h.String="[object String]",h.Boolean="[object Boolean]",h.Undefined="[object Undefined]",h.Null="[object Null]",h.Error="[object Error]";var v=function(e){return Object.prototype.toString.call(e)===d.String},g=function(e){return Object.prototype.toString.call(e)===d.Function},y="undefined"!=typeof window,m=function(){var e,t="".concat(process.cwd(),"/docs/.linkcard_cache.json"),r="".concat(process.cwd(),"/.linkcard_cache.json");if(i.existsSync(t))e=t;else if(i.existsSync(r))e=r;else{e=t;i.writeFileSync(e,JSON.stringify({"https://example.com/":{description:"Example Website",logo:"https://example.com/example.png",title:"Example Title"}},null,2))}return e},b=function(){return function(e,t,r){return t&&s(e.prototype,t),r&&s(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e}(function e(){!function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,e)},[{key:"setFile",value:function(e){var t=e,r=this.readFile();r&&(t=Object.assign(r,t)),i.writeFileSync(m(),JSON.stringify(t)),function(){var e=m(),t=i.readFileSync(e,"utf-8").trim();if(t){var r=JSON.parse(t),n=JSON.stringify(r,null,2)+"\n";i.writeFileSync(e,n)}}()}},{key:"readFile",value:function(){var e=i.readFileSync(m(),"utf-8"),t=JSON.parse(e);if(function(e){return Object.prototype.toString.call(e)===d.Object}(t))return t}},{key:"has",value:function(e){return!!this.get(e)}},{key:"get",value:function(e){var t=this.readFile();return null==t?void 0:t[e]}},{key:"set",value:function(e,t){this.setFile(c({},e,t))}}])}(),E=new b;function w(e){return'style="'.concat(function(e){return Object.entries(e).map(function(e){var t,r=f(e,2),n=r[0],o=r[1];if(n&&o)return"".concat((t=n,t.replace(/\B([A-Z])/g,"-$1").toLowerCase()),": ").concat(o,";")}).filter(Boolean).join(" ")}(e),'"')}var x=function(e){return{"-webkit-box-orient":"vertical","-webkit-line-clamp":e,display:"-webkit-box",hyphens:"auto",lineClamp:e,overflow:"hidden",overflowWrap:"anywhere",textOverflow:"ellipsis",wordBreak:"break-word"}},S=function(e,t){var r,n,o={rel:'rel="noopener noreferrer"',target:'target="'.concat(t.target,'"'),href:'href="'.concat(t.href,'"'),title:'title="'.concat(t.linkTitle,'"')},i=function(e){return e.replace(/&amp;/g,"&").replace(/&lt;/g,"<").replace(/&gt;/g,">").replace(/&quot;/g,'"').replace(/&#039;/g,"'")},a={a:w({color:"unset !important",display:"block",width:"100%",textDecoration:"none"}),container:w({display:"flex",alignItems:"center",flexWrap:"wrap",gap:"10px",borderRadius:"12px",border:"1px solid var(--vp-c-bg)",backgroundColor:"var(--vp-c-bg-soft)",boxSizing:"border-box",width:"100%",height:"130px",transition:"all 0.25s"}),img:w({borderRadius:"0px 12px 12px 0px",maxWidth:"40%",height:"128px",flexShrink:0,objectFit:"contain",overflow:"hidden"}),texts:w({flex:"1 1 0%",minWidth:"0"}),title:w(u(u({},x(2)),{},{opacity:1,fontSize:"16px",lineHeight:"22px",margin:"0 16px 8px 16px",fontWeight:"bold"})),domain:w(u(u({},x(1)),{},{opacity:1,fontSize:"12px",lineHeight:"16px",margin:"8px 16px 8px 16px",textDecoration:"underline"})),description:w(u(u({},x(2)),{},{opacity:.8,fontSize:"12px",lineHeight:"16px",margin:"8px 16px 0px 16px"}))},s=t.href||"",c=new URL(s).origin.replace(/^https?:\/\//,"").replace(/^www\./,"")||"Unknown domain",l=e.title,f=e.description;"github.com"==c?(l=(null===(r=e.title)||void 0===r?void 0:r.split(":")[0].replace("GitHub - ",""))||"No title",f=(null===(n=f)||void 0===n?void 0:n.replace(" - ".concat(l),"").replace("Contribute to ".concat(l," development by creating an account on GitHub."),""))||""):(l=e.title||"No title",f=e.description||"");return'<span style="display:block;">\n  <a '.concat(o.rel," ").concat(o.target," ").concat(o.href," ").concat(o.title," ").concat(a.a,'>\n    <span class="vitepress-linkcard-container" ').concat(a.container,">\n      <span ").concat(a.texts,">\n        <span ").concat(a.title,">\n          ").concat(i(l),"\n        </span>\n        <span ").concat(a.domain,">\n          ").concat(i(c),"\n        </span>\n        <span ").concat(a.description,">\n          ").concat(i(f),'\n        </span>\n      </span>\n      <img src="').concat(null==e?void 0:e.logo,'" ').concat(a.img,"/>\n    </span>\n  </a>\n</span>")};function O(e){return new URL(e)}var N="https://resources.whatwg.org/logo-url.svg",k=/(<[A-Za-z]+\s*[^>]*>(.*)<\/[A-Za-z]+>)/,T=/content=["|']([^>]*)["|']/,j=/href=["|']([^>]*)["|']/,C=/(<title\s*[^>]*>(.*)<\/title>)/g,R=function(e){return new RegExp("<".concat(arguments.length>1&&void 0!==arguments[1]?arguments[1]:"meta","\\s[^>]*\\w+=['|\"]([a-zA-Z]|:|\\s)*").concat(e,"['|\"][^>]*\\/?>"))};function D(e){var t,r=e.match(R("title"));if(null!=r&&r.length){var n=r[0].match(T);n&&v(n[1])&&(t=n[1])}else{var o=e.match(C);if(null!=o&&o.length){var i=o[0].match(k);i&&v(i[2])&&(t=i[2])}}return t}function A(e){var t,r=e.match(R("description"));if(null!=r&&r.length){var n=r[0].match(T);n&&v(n[1])&&(t=n[1])}return t}function L(e){var t,r=e.match(R("image"));if(null!=r&&r.length){var n=r[0].match(T);n&&v(n[1])&&(t=n[1])}else{var o=e.match(R("icon","link"));if(null!=o&&o.length){var i=o[0].match(j);i&&v(i[1])&&(t=i[1])}}return t}function P(e,t){var r,n,o,i={title:D(e),description:A(e),logo:(r=L(e),r?O(r)?r:"".concat(null===(n=O(t))||void 0===n?void 0:n.origin).concat("/".concat(r).replace(/\/\//g,"/")):N)};return o=i,Object.values(o).filter(function(e){return v(e)}).length?i:null}function q(e){return e&&e.__esModule&&Object.prototype.hasOwnProperty.call(e,"default")?e.default:e}var H,F={};
+/**
+ * Wrapper for built-in http.js to emulate the browser XMLHttpRequest object.
+ *
+ * This can be used with JS designed for browsers to improve reuse of code and
+ * allow the use of existing libraries.
+ *
+ * Usage: include("XMLHttpRequest.js") and use XMLHttpRequest per W3C specs.
+ *
+ * @author Dan DeFelippi <dan@driverdan.com>
+ * @contributor David Ellis <d.f.ellis@ieee.org>
+ * @license MIT
+ */var _=function(){if(H)return F;H=1;var i=e,a=t.spawn,s=r;return F.XMLHttpRequest=function(){var e,t,r=this,c=n,l=o,u={},f=!1,p={"User-Agent":"node-XMLHttpRequest",Accept:"*/*"},d={},h={},v=["accept-charset","accept-encoding","access-control-request-headers","access-control-request-method","connection","content-length","content-transfer-encoding","cookie","cookie2","date","expect","host","keep-alive","origin","referer","te","trailer","transfer-encoding","upgrade","via"],g=["TRACE","TRACK","CONNECT"],y=!1,m=!1,b={};this.UNSENT=0,this.OPENED=1,this.HEADERS_RECEIVED=2,this.LOADING=3,this.DONE=4,this.readyState=this.UNSENT,this.onreadystatechange=null,this.responseText="",this.responseXML="",this.status=null,this.statusText=null,this.withCredentials=!1;this.open=function(e,t,r,n,o){if(this.abort(),m=!1,!function(e){return e&&-1===g.indexOf(e)}(e))throw new Error("SecurityError: Request method not allowed");u={method:e,url:t.toString(),async:"boolean"!=typeof r||r,user:n||null,password:o||null},E(this.OPENED)},this.setDisableHeaderCheck=function(e){f=e},this.setRequestHeader=function(e,t){if(this.readyState!==this.OPENED)throw new Error("INVALID_STATE_ERR: setRequestHeader can only be called when state is OPEN");if(function(e){return f||e&&-1===v.indexOf(e.toLowerCase())}(e)){if(y)throw new Error("INVALID_STATE_ERR: send flag is true");e=h[e.toLowerCase()]||e,h[e.toLowerCase()]=e,d[e]=d[e]?d[e]+", "+t:t}else console.warn('Refused to set unsafe header "'+e+'"')},this.getResponseHeader=function(e){return"string"==typeof e&&this.readyState>this.OPENED&&t&&t.headers&&t.headers[e.toLowerCase()]&&!m?t.headers[e.toLowerCase()]:null},this.getAllResponseHeaders=function(){if(this.readyState<this.HEADERS_RECEIVED||m)return"";var e="";for(var r in t.headers)"set-cookie"!==r&&"set-cookie2"!==r&&(e+=r+": "+t.headers[r]+"\r\n");return e.substr(0,e.length-2)},this.getRequestHeader=function(e){return"string"==typeof e&&h[e.toLowerCase()]?d[h[e.toLowerCase()]]:""},this.send=function(n){if(this.readyState!==this.OPENED)throw new Error("INVALID_STATE_ERR: connection must be opened before send() is called");if(y)throw new Error("INVALID_STATE_ERR: send has already been called");var o,f=!1,v=!1,g=i.parse(u.url);switch(g.protocol){case"https:":f=!0;case"http:":o=g.hostname;break;case"file:":v=!0;break;case void 0:case null:case"":o="localhost";break;default:throw new Error("Protocol not supported.")}if(v){if("GET"!==u.method)throw new Error("XMLHttpRequest: Only GET method is supported");if(u.async)s.readFile(g.pathname,"utf8",function(e,t){e?r.handleError(e):(r.status=200,r.responseText=t,E(r.DONE))});else try{this.responseText=s.readFileSync(g.pathname,"utf8"),this.status=200,E(r.DONE)}catch(e){this.handleError(e)}}else{var b=g.port||(f?443:80),w=g.pathname+(g.search?g.search:"");for(var x in p)h[x.toLowerCase()]||(d[x]=p[x]);if(d.Host=o,f&&443===b||80===b||(d.Host+=":"+g.port),u.user){void 0===u.password&&(u.password="");var S=new Buffer(u.user+":"+u.password);d.Authorization="Basic "+S.toString("base64")}"GET"===u.method||"HEAD"===u.method?n=null:n?(d["Content-Length"]=Buffer.isBuffer(n)?n.length:Buffer.byteLength(n),d["Content-Type"]||(d["Content-Type"]="text/plain;charset=UTF-8")):"POST"===u.method&&(d["Content-Length"]=0);var O={host:o,port:b,path:w,method:u.method,headers:d,agent:!1,withCredentials:r.withCredentials};if(m=!1,u.async){var N=f?l.request:c.request;y=!0,r.dispatchEvent("readystatechange");var k=function(e){r.handleError(e)};e=N(O,function n(a){if(301!==(t=a).statusCode&&302!==t.statusCode&&303!==t.statusCode&&307!==t.statusCode)t.setEncoding("utf8"),E(r.HEADERS_RECEIVED),r.status=t.statusCode,t.on("data",function(e){e&&(r.responseText+=e),y&&E(r.LOADING)}),t.on("end",function(){y&&(E(r.DONE),y=!1)}),t.on("error",function(e){r.handleError(e)});else{u.url=t.headers.location;var s=i.parse(u.url);o=s.hostname;var c={hostname:s.hostname,port:s.port,path:s.path,method:303===t.statusCode?"GET":u.method,headers:d,withCredentials:r.withCredentials};(e=N(c,n).on("error",k)).end()}}).on("error",k),n&&e.write(n),e.end(),r.dispatchEvent("loadstart")}else{var T=".node-xmlhttprequest-content-"+process.pid,j=".node-xmlhttprequest-sync-"+process.pid;s.writeFileSync(j,"","utf8");for(var C="var http = require('http'), https = require('https'), fs = require('fs');var doRequest = http"+(f?"s":"")+".request;var options = "+JSON.stringify(O)+";var responseText = '';var req = doRequest(options, function(response) {response.setEncoding('utf8');response.on('data', function(chunk) {  responseText += chunk;});response.on('end', function() {fs.writeFileSync('"+T+"', JSON.stringify({err: null, data: {statusCode: response.statusCode, headers: response.headers, text: responseText}}), 'utf8');fs.unlinkSync('"+j+"');});response.on('error', function(error) {fs.writeFileSync('"+T+"', JSON.stringify({err: error}), 'utf8');fs.unlinkSync('"+j+"');});}).on('error', function(error) {fs.writeFileSync('"+T+"', JSON.stringify({err: error}), 'utf8');fs.unlinkSync('"+j+"');});"+(n?"req.write('"+JSON.stringify(n).slice(1,-1).replace(/'/g,"\\'")+"');":"")+"req.end();",R=a(process.argv[0],["-e",C]);s.existsSync(j););var D=JSON.parse(s.readFileSync(T,"utf8"));R.stdin.end(),s.unlinkSync(T),D.err?r.handleError(D.err):(t=D.data,r.status=D.data.statusCode,r.responseText=D.data.text,E(r.DONE))}}},this.handleError=function(e){this.status=0,this.statusText=e,this.responseText=e.stack,m=!0,E(this.DONE),this.dispatchEvent("error")},this.abort=function(){e&&(e.abort(),e=null),d=p,this.status=0,this.responseText="",this.responseXML="",m=!0,this.readyState===this.UNSENT||this.readyState===this.OPENED&&!y||this.readyState===this.DONE||(y=!1,E(this.DONE)),this.readyState=this.UNSENT,this.dispatchEvent("abort")},this.addEventListener=function(e,t){e in b||(b[e]=[]),b[e].push(t)},this.removeEventListener=function(e,t){e in b&&(b[e]=b[e].filter(function(e){return e!==t}))},this.dispatchEvent=function(e){if("function"==typeof r["on"+e]&&r["on"+e](),e in b)for(var t=0,n=b[e].length;t<n;t++)b[e][t].call(r)};var E=function(e){e!=r.LOADING&&r.readyState===e||(r.readyState=e,(u.async||r.readyState<r.OPENED||r.readyState===r.DONE)&&r.dispatchEvent("readystatechange"),r.readyState!==r.DONE||m||(r.dispatchEvent("load"),r.dispatchEvent("loadend")))}},F}(),I=q(_),U=new Map,B=y?window.XMLHttpRequest:I.XMLHttpRequest;function J(e){if(U.has(e))return U.get(e);var t;try{var r=new B;r.open("GET",e,!1),r.setRequestHeader("Content-Type","text/html"),r.send(),200===r.status&&r.responseText&&(t=r.responseText,U.set(e,r.responseText))}catch(e){console.error("【XHR Error】：".concat(e instanceof Error?e.message:"get remote URL resource exception!"))}return t}var M=new Map;function G(e,t){return new Promise(function(r){var n=J(e);if(n){var o=P(n,e);if(o){var i={linkTitle:t.linkTitle,target:t.target||"_blank",classPrefix:t.classPrefix},a=S(o,u(u({},i),{},{href:e})),s={url:e,data:o,options:i,dom:a};M.set(e,s),r(s)}}})}var z=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};function r(e){var r,n=function(e){if(E.has(e))return E.get(e);var t=null,r=J(e);return r&&(t=P(r,e))&&E.set(e,t),t}(e.url);if(n){!function(e,t){e.forEach(function(e,r){r!==t&&(e.hidden=!0)})}(e.tokens,e.i);var o={href:e.url,linkTitle:(r=e.tokens,r.map(function(e){var t=e.hidden,r=e.content;return t?r:""}).filter(Boolean).join("")),target:t.target||"_blank",classPrefix:t.classPrefix};return g(t.render)?t.render(n,o):S(n,o)}}e.renderer.renderInline=function(t,r,n){for(var o="",i=0;i<t.length;i++){var a=t[i],s=e.renderer.rules[a.type];a.hidden?o+="":g(s)?o+=s(t,i,r,n,e.renderer):o+=e.renderer.renderToken(t,i,r)}return o},e.renderer.rules.link_open=function(e,t,n,o,i){var a,s=e[t],c="a"===s.tag&&"link_open"===s.type,l=function(e){var t=new RegExp("^(".concat("@",":)([a-zA-Z0-9]+.*)")),r=null==e?void 0:e.match(t);return{isCardLink:!!r,url:null==r?void 0:r[2]}}(null===(a=s.attrs)||void 0===a||null===(a=a.filter(function(e){return e.includes("href")})[0])||void 0===a?void 0:a[1]),u=l.url,f=l.isCardLink;if(c&&f&&u){var p=r({url:u,tokens:e,i:t});if(p)return p}return i.renderToken(e,t,n)}};export{G as generateCard,z as linkToCardPlugin};

package/dist/api.js

@@ -0,0 +1,36 @@
+import { xhr, generateCardDomFragment, parserMetadata } from './assemble';
+const cache = new Map();
+/**
+ * Generates a link card by fetching and parsing metadata from a URL.
+ *
+ * @param url - The URL to fetch metadata from
+ * @param options - Rendering options for the card
+ * @returns A promise that resolves to a CardResponse containing the card data and HTML
+ */
+export function generateCard(url, options) {
+    return new Promise((resolve) => {
+        const htmlString = xhr.sync(url);
+        if (htmlString) {
+            const urlMetadata = parserMetadata(htmlString, url);
+            if (urlMetadata) {
+                const _options = {
+                    linkTitle: options.linkTitle,
+                    target: options.target || '_blank',
+                    classPrefix: options.classPrefix
+                };
+                const card = generateCardDomFragment(urlMetadata, {
+                    ..._options,
+                    href: url
+                });
+                const response = {
+                    url,
+                    data: urlMetadata,
+                    options: _options,
+                    dom: card
+                };
+                cache.set(url, response);
+                resolve(response);
+            }
+        }
+    });
+}

package/dist/assemble/html.js

@@ -0,0 +1,60 @@
+import { STYLE } from './style';
+/**
+ * Generates the HTML DOM fragment for a link card display.
+ *
+ * @param data - The metadata extracted from the URL
+ * @param options - Rendering options including href, target, etc.
+ * @returns An HTML string containing the card markup
+ */
+export const generateCardDomFragment = (data, options) => {
+    const aa = {
+        rel: `rel="noopener noreferrer"`,
+        target: `target="${options.target}"`,
+        href: `href="${options.href}"`,
+        title: `title="${options.linkTitle}"`
+    };
+    const inject = (s) => {
+        return s;
+    };
+    const escapeHTML = (str) => str
+        .replace(/&/g, '&')
+        .replace(/&lt;/g, '<')
+        .replace(/&gt;/g, '>')
+        .replace(/&quot;/g, '"')
+        .replace(/&#039;/g, "'");
+    const style = STYLE();
+    const url = options.href || '';
+    const domain = new URL(url).origin.replace(/^https?:\/\//, '').replace(/^www\./, '') ||
+        'Unknown domain';
+    let title = data.title;
+    let description = data.description;
+    if (domain == 'github.com') {
+        title = data.title?.split(':')[0].replace('GitHub - ', '') || 'No title';
+        description =
+            description
+                ?.replace(` - ${title}`, '')
+                .replace(`Contribute to ${title} development by creating an account on GitHub.`, '') || '';
+    }
+    else {
+        title = data.title || 'No title';
+        description = data.description || '';
+    }
+    return `<span style="display:block;">
+  <a ${aa.rel} ${aa.target} ${aa.href} ${aa.title} ${style.a}>
+    <span class="vitepress-linkcard-container" ${inject(style.container)}>
+      <span ${inject(style.texts)}>
+        <span ${inject(style.title)}>
+          ${escapeHTML(title)}
+        </span>
+        <span ${inject(style.domain)}>
+          ${escapeHTML(domain)}
+        </span>
+        <span ${inject(style.description)}>
+          ${escapeHTML(description)}
+        </span>
+      </span>
+      <img src="${data?.logo}" ${inject(style.img)}/>
+    </span>
+  </a>
+</span>`;
+};

package/dist/assemble/index.js

@@ -0,0 +1,4 @@
+export * from './metadata';
+export * from './html';
+export * from './parser';
+export * as xhr from './xhr';

package/dist/assemble/local-file-cache.js

@@ -0,0 +1,66 @@
+import { isPureObject } from '@luckrya/utility';
+import fs from 'node:fs';
+const CONFIG_FILE = () => {
+    let filePath;
+    const defaultPath = `${process.cwd()}/docs/.linkcard_cache.json`;
+    const fallbackPath = `${process.cwd()}/.linkcard_cache.json`;
+    if (fs.existsSync(defaultPath)) {
+        filePath = defaultPath;
+    }
+    else if (fs.existsSync(fallbackPath)) {
+        filePath = fallbackPath;
+    }
+    else {
+        filePath = defaultPath;
+        const initialData = {
+            'https://example.com/': {
+                description: 'Example Website',
+                logo: 'https://example.com/example.png',
+                title: 'Example Title'
+            }
+        };
+        fs.writeFileSync(filePath, JSON.stringify(initialData, null, 2));
+    }
+    return filePath;
+};
+const format = () => {
+    const filePath = CONFIG_FILE();
+    const content = fs.readFileSync(filePath, 'utf-8').trim();
+    if (!content)
+        return;
+    const parsed = JSON.parse(content);
+    const formatted = JSON.stringify(parsed, null, 2) + '\n';
+    fs.writeFileSync(filePath, formatted);
+};
+/**
+ * A simple file-based cache for storing and retrieving structured data.
+ */
+export default class LocalFileCache {
+    constructor() { }
+    setFile(data) {
+        let content = data;
+        const _content = this.readFile();
+        if (_content) {
+            content = Object.assign(_content, content);
+        }
+        fs.writeFileSync(CONFIG_FILE(), JSON.stringify(content));
+        format();
+    }
+    readFile() {
+        const content = fs.readFileSync(CONFIG_FILE(), 'utf-8');
+        const data = JSON.parse(content);
+        if (isPureObject(data))
+            return data;
+        return undefined;
+    }
+    has(url) {
+        return !!this.get(url);
+    }
+    get(url) {
+        const cache = this.readFile();
+        return cache?.[url];
+    }
+    set(url, data) {
+        this.setFile({ [url]: data });
+    }
+}

package/dist/assemble/metadata.js

@@ -0,0 +1,21 @@
+import { parserMetadata, xhr } from '.';
+import LocalFileCache from './local-file-cache';
+const cache = new LocalFileCache();
+/**
+ * Retrieves metadata for a given URL, using cache when available.
+ *
+ * @param url - The URL to fetch metadata from
+ * @returns The parsed URL metadata, or null if unavailable
+ */
+export function getUrlMetadata(url) {
+    if (cache.has(url))
+        return cache.get(url);
+    let metadata = null;
+    const htmlString = xhr.sync(url);
+    if (htmlString) {
+        metadata = parserMetadata(htmlString, url);
+        if (metadata)
+            cache.set(url, metadata);
+    }
+    return metadata;
+}

package/dist/assemble/parser.js

@@ -0,0 +1,82 @@
+import { isString } from '@luckrya/utility';
+import { cleanPath, extractUrl } from './url';
+const DEFAULT_LOGO = 'https://resources.whatwg.org/logo-url.svg';
+const HtmlTagContentReg = /(<[A-Za-z]+\s*[^>]*>(.*)<\/[A-Za-z]+>)/;
+const ContentAttrValueHtmlMetaTagReg = /content=["|']([^>]*)["|']/;
+const HrefAttrValueHtmlLinkTagReg = /href=["|']([^>]*)["|']/;
+const HtmlTitleTagReg = /(<title\s*[^>]*>(.*)<\/title>)/g;
+const containArrSelfLosingHtmlTagReg = (attr, tag = 'meta') => new RegExp(`<${tag}\\s[^>]*\\w+=['|"]([a-zA-Z]|:|\\s)*${attr}['|"][^>]*\\/?>`);
+function matchTitleByMetaTag(htmlString) {
+    let title;
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('title'));
+    if (metas?.length) {
+        const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
+        if (content && isString(content[1]))
+            title = content[1];
+    }
+    else {
+        const titleHtmlTag = htmlString.match(HtmlTitleTagReg);
+        if (titleHtmlTag?.length) {
+            const content = titleHtmlTag[0].match(HtmlTagContentReg);
+            if (content && isString(content[2]))
+                title = content[2];
+        }
+    }
+    return title;
+}
+function matchDescriptionByMetaTag(htmlString) {
+    let description;
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('description'));
+    if (metas?.length) {
+        const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
+        if (content && isString(content[1]))
+            description = content[1];
+    }
+    return description;
+}
+function matchLogoByLinkOrMetaTag(htmlString) {
+    let logo;
+    const metas = htmlString.match(containArrSelfLosingHtmlTagReg('image'));
+    if (metas?.length) {
+        const content = metas[0].match(ContentAttrValueHtmlMetaTagReg);
+        if (content && isString(content[1]))
+            logo = content[1];
+    }
+    else {
+        const linkHtmlTags = htmlString.match(containArrSelfLosingHtmlTagReg('icon', 'link'));
+        if (linkHtmlTags?.length) {
+            const content = linkHtmlTags[0].match(HrefAttrValueHtmlLinkTagReg);
+            if (content && isString(content[1]))
+                logo = content[1];
+        }
+    }
+    return logo;
+}
+/**
+ * Parses HTML string to extract structured metadata for link card generation.
+ *
+ * @param htmlString - The HTML content to parse
+ * @param url - The URL of the page
+ * @returns Parsed metadata object, or null if no valid metadata found
+ */
+export function parserMetadata(htmlString, url) {
+    function absolute(logo) {
+        if (!logo)
+            return DEFAULT_LOGO;
+        return extractUrl(logo)
+            ? logo
+            : `${extractUrl(url)?.origin}${cleanPath(`/${logo}`)}`;
+    }
+    const metadata = {
+        title: matchTitleByMetaTag(htmlString),
+        description: matchDescriptionByMetaTag(htmlString),
+        logo: absolute(matchLogoByLinkOrMetaTag(htmlString))
+    };
+    if (isEmptyStringObject(metadata))
+        return null;
+    else
+        return metadata;
+}
+function isEmptyStringObject(obj) {
+    return !Object.values(obj).filter((v) => isString(v)).length;
+}

package/dist/assemble/style.js

@@ -0,0 +1,93 @@
+function hyphenate(str) {
+    return str.replace(/\B([A-Z])/g, '-$1').toLowerCase();
+}
+function join(style) {
+    return Object.entries(style)
+        .map(([k, v]) => {
+        if (k && v)
+            return `${hyphenate(k)}: ${v};`;
+    })
+        .filter(Boolean)
+        .join(' ');
+}
+function inlineStyle(style) {
+    return `style="${join(style)}"`;
+}
+const ellipsisStyle = (line) => ({
+    '-webkit-box-orient': 'vertical',
+    '-webkit-line-clamp': line,
+    display: '-webkit-box',
+    hyphens: 'auto',
+    lineClamp: line,
+    overflow: 'hidden',
+    overflowWrap: 'anywhere',
+    textOverflow: 'ellipsis',
+    wordBreak: 'break-word'
+});
+/**
+ * Generates complete inline styles for all link card components.
+ */
+export const STYLE = () => ({
+    a: inlineStyle({
+        color: 'unset !important',
+        display: 'block',
+        width: '100%',
+        textDecoration: 'none'
+    }),
+    container: inlineStyle({
+        display: 'flex',
+        alignItems: 'center',
+        flexWrap: 'wrap',
+        gap: '10px',
+        borderRadius: '12px',
+        border: `1px solid var(--vp-c-bg)`,
+        backgroundColor: `var(--vp-c-bg-soft)`,
+        boxSizing: 'border-box',
+        width: '100%',
+        height: '130px',
+        transition: 'all 0.25s'
+    }),
+    img: inlineStyle({
+        borderRadius: '0px 12px 12px 0px',
+        maxWidth: '40%',
+        height: '128px',
+        flexShrink: 0,
+        objectFit: 'contain',
+        overflow: 'hidden'
+    }),
+    texts: inlineStyle({
+        flex: '1 1 0%',
+        minWidth: '0'
+    }),
+    title: inlineStyle({
+        ...ellipsisStyle(2),
+        opacity: 1,
+        fontSize: '16px',
+        lineHeight: '22px',
+        margin: '0 16px 8px 16px',
+        fontWeight: 'bold'
+    }),
+    domain: inlineStyle({
+        ...ellipsisStyle(1),
+        opacity: 1,
+        fontSize: '12px',
+        lineHeight: '16px',
+        margin: '8px 16px 8px 16px',
+        textDecoration: 'underline'
+    }),
+    description: inlineStyle({
+        ...ellipsisStyle(2),
+        opacity: 0.8,
+        fontSize: '12px',
+        lineHeight: '16px',
+        margin: '8px 16px 0px 16px'
+    })
+});
+export const classNames = (prefix) => ({
+    container: `${prefix}__container`,
+    img: `${prefix}__img`,
+    texts: `${prefix}__texts`,
+    title: `${prefix}__texts--title`,
+    domain: `${prefix}__texts--domain`,
+    description: `${prefix}__texts--desc`
+});

package/dist/assemble/url.js

@@ -0,0 +1,18 @@
+/**
+ * Parses a URL string and returns a URL object.
+ *
+ * @param url - The URL string to parse
+ * @returns A URL object containing the parsed components
+ */
+export function extractUrl(url) {
+    return new URL(url);
+}
+/**
+ * Removes duplicate consecutive slashes from a path string.
+ *
+ * @param path - The path string to clean
+ * @returns The cleaned path with no consecutive slashes
+ */
+export function cleanPath(path) {
+    return path.replace(/\/\//g, '/');
+}

package/dist/assemble/xhr.js

@@ -0,0 +1,59 @@
+// @ts-expect-error: xmlhttprequest has no types
+import xhrForNode from 'xmlhttprequest';
+import { inBrowser, isString } from '@luckrya/utility';
+const cache = new Map();
+const XHR = inBrowser ? window.XMLHttpRequest : xhrForNode.XMLHttpRequest;
+/**
+ * Performs a synchronous HTTP GET request to fetch HTML content from a URL.
+ *
+ * @param url - The URL to fetch content from
+ * @returns The HTML content as a string, or undefined if the request fails
+ */
+export function sync(url) {
+    if (cache.has(url))
+        return cache.get(url);
+    let result;
+    try {
+        const xhr = new XHR();
+        xhr.open('GET', url, false);
+        xhr.setRequestHeader('Content-Type', 'text/html');
+        xhr.send();
+        if (xhr.status === 200 && !!xhr.responseText) {
+            result = xhr.responseText;
+            cache.set(url, xhr.responseText);
+        }
+    }
+    catch (err) {
+        console.error(`【XHR Error】：${err instanceof Error ? err.message : 'get remote URL resource exception!'}`);
+    }
+    return result;
+}
+/**
+ * Performs an asynchronous HTTP GET request to fetch HTML content from a URL.
+ *
+ * @param url - The URL to fetch content from
+ * @returns A Promise that resolves to the HTML content string
+ */
+export function async(url) {
+    return new Promise((resolve, reject) => {
+        try {
+            if (cache.has(url))
+                return resolve(cache.get(url));
+            const xhr = new XHR();
+            xhr.open('GET', url, false);
+            xhr.setRequestHeader('Content-Type', 'text/html');
+            xhr.onreadystatechange = function () {
+                if (xhr.readyState === 4 &&
+                    xhr.status === 200 &&
+                    isString(xhr.responseText)) {
+                    cache.set(url, xhr.responseText);
+                    resolve(xhr.responseText);
+                }
+            };
+            xhr.send();
+        }
+        catch (err) {
+            reject(err);
+        }
+    });
+}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './link-to-card-plugin';
+export * from './types';

package/dist/link-to-card-plugin.js

@@ -0,0 +1,78 @@
+import { isFunction } from '@luckrya/utility';
+import { getUrlMetadata, generateCardDomFragment } from './assemble';
+/**
+ * Markdown-it plugin that converts specially-formatted links into rich link preview cards.
+ *
+ * @param md - The markdown-it instance
+ * @param pluginOptions - Configuration options for the plugin
+ */
+export const linkToCardPlugin = (md, pluginOptions = {}) => {
+    function parseCardLinkHref(href) {
+        const tagRegexp = new RegExp(`^(${'@'}:)([a-zA-Z0-9]+.*)`);
+        const match = href?.match(tagRegexp);
+        return {
+            isCardLink: !!match,
+            url: match?.[2]
+        };
+    }
+    function assembleCardTpl(options) {
+        const urlMetadata = getUrlMetadata(options.url);
+        if (urlMetadata) {
+            ignoreRestToken(options.tokens, options.i);
+            const cardDomOptions = {
+                href: options.url,
+                linkTitle: joinLinkTitle(options.tokens),
+                target: pluginOptions.target || '_blank',
+                classPrefix: pluginOptions.classPrefix
+            };
+            return isFunction(pluginOptions.render)
+                ? pluginOptions.render(urlMetadata, cardDomOptions)
+                : generateCardDomFragment(urlMetadata, cardDomOptions);
+        }
+    }
+    md.renderer.renderInline = (tokens, rootOptions, env) => {
+        let result = '';
+        for (let i = 0; i < tokens.length; i++) {
+            const currentToken = tokens[i];
+            const ruleFunction = md.renderer.rules[currentToken.type];
+            if (currentToken.hidden) {
+                result += '';
+            }
+            else if (isFunction(ruleFunction)) {
+                result += ruleFunction(tokens, i, rootOptions, env, md.renderer);
+            }
+            else {
+                result += md.renderer.renderToken(tokens, i, rootOptions);
+            }
+        }
+        return result;
+    };
+    md.renderer.rules.link_open = (tokens, i, rootOptions, env, self) => {
+        const token = tokens[i];
+        const isLinkOpenToken = token.tag === 'a' && token.type === 'link_open';
+        const href = token.attrs?.filter((attr) => attr.includes('href'))[0]?.[1];
+        const { url, isCardLink } = parseCardLinkHref(href);
+        if (isLinkOpenToken && isCardLink && url) {
+            const card = assembleCardTpl({ url, tokens, i });
+            if (card)
+                return card;
+        }
+        return self.renderToken(tokens, i, rootOptions);
+    };
+};
+function ignoreRestToken(tokens, i) {
+    tokens.forEach((token, index) => {
+        if (index !== i)
+            token.hidden = true;
+    });
+}
+function joinLinkTitle(tokens) {
+    return tokens
+        .map(({ hidden, content }) => {
+        if (hidden)
+            return content;
+        return '';
+    })
+        .filter(Boolean)
+        .join('');
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "vitepress-linkcards",
+  "version": "2.2.2",
+  "description": "A Vitepress plugin to generate a pretty linkcard with OGP.",
+  "keywords": [
+    "linkcard",
+    "markdown-it",
+    "ogp",
+    "thumbnail",
+    "vitepress",
+    "vitepress-plugin"
+  ],
+  "bugs": {
+    "url": "https://github.com/asumo-1xts/vitepress-linkcard"
+  },
+  "license": "MIT",
+  "author": "aSumo",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asumo-1xts/vitepress-linkcard.git"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
+  "type": "module",
+  "main": "./dist/.esm.min.js",
+  "module": "./dist/.esm.min.js",
+  "types": "./types/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc && rollup -c",
+    "clean": "rm -rf dist types",
+    "dev": "rollup -c -w",
+    "docs": "typedoc",
+    "format": "oxfmt --write",
+    "lint": "oxlint",
+    "lint:github": "oxlint --format=github",
+    "type:dts": "tsc --emitDeclarationOnly"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@luckrya/utility": "^0.1.1",
+    "@rollup/plugin-babel": "^6.1.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@types/babel__core": "^7",
+    "@types/markdown-it": "^13.0.2",
+    "@types/node": "^25.0.3",
+    "markdown-it": "^13.0.2",
+    "oxfmt": "^0.26.0",
+    "oxlint": "^1.41.0",
+    "rollup": "^2.79.2",
+    "rollup-plugin-terser": "^7.0.2",
+    "typedoc": "^0.28.15",
+    "typedoc-theme-hierarchy": "^6.0.0",
+    "typescript": "^5.9.3",
+    "xmlhttprequest": "^1.8.0"
+  },
+  "babel": {
+    "presets": [
+      "@babel/env",
+      "@babel/typescript"
+    ]
+  },
+  "packageManager": "yarn@4.9.2"
+}

package/types/api.d.ts

@@ -0,0 +1,16 @@
+import type { UrlMetadata, CardDomRenderOptions } from './types';
+interface CardResponse {
+    url: string;
+    data: UrlMetadata;
+    options: Omit<CardDomRenderOptions, 'href'>;
+    dom: string;
+}
+/**
+ * Generates a link card by fetching and parsing metadata from a URL.
+ *
+ * @param url - The URL to fetch metadata from
+ * @param options - Rendering options for the card
+ * @returns A promise that resolves to a CardResponse containing the card data and HTML
+ */
+export declare function generateCard(url: string, options: Omit<CardDomRenderOptions, 'href'>): Promise<CardResponse>;
+export {};

package/types/assemble/html.d.ts

@@ -0,0 +1,9 @@
+import type { CardDomRender } from '../types';
+/**
+ * Generates the HTML DOM fragment for a link card display.
+ *
+ * @param data - The metadata extracted from the URL
+ * @param options - Rendering options including href, target, etc.
+ * @returns An HTML string containing the card markup
+ */
+export declare const generateCardDomFragment: CardDomRender;

package/types/assemble/index.d.ts

@@ -0,0 +1,4 @@
+export * from './metadata';
+export * from './html';
+export * from './parser';
+export * as xhr from './xhr';

package/types/assemble/local-file-cache.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A simple file-based cache for storing and retrieving structured data.
+ */
+export default class LocalFileCache<V extends Record<string, unknown>> {
+    constructor();
+    private setFile;
+    private readFile;
+    has(url: string): boolean;
+    get(url: string): V | undefined;
+    set(url: string, data: V): void;
+}

package/types/assemble/metadata.d.ts

@@ -0,0 +1,8 @@
+import type { UrlMetadata } from '../types';
+/**
+ * Retrieves metadata for a given URL, using cache when available.
+ *
+ * @param url - The URL to fetch metadata from
+ * @returns The parsed URL metadata, or null if unavailable
+ */
+export declare function getUrlMetadata(url: string): UrlMetadata | null | undefined;

package/types/assemble/parser.d.ts

@@ -0,0 +1,9 @@
+import type { UrlMetadata } from '../types';
+/**
+ * Parses HTML string to extract structured metadata for link card generation.
+ *
+ * @param htmlString - The HTML content to parse
+ * @param url - The URL of the page
+ * @returns Parsed metadata object, or null if no valid metadata found
+ */
+export declare function parserMetadata(htmlString: string, url: string): UrlMetadata | null;

package/types/assemble/style.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generates complete inline styles for all link card components.
+ */
+export declare const STYLE: () => {
+    a: string;
+    container: string;
+    img: string;
+    texts: string;
+    title: string;
+    domain: string;
+    description: string;
+};
+export declare const classNames: (prefix?: string) => {
+    container: string;
+    img: string;
+    texts: string;
+    title: string;
+    domain: string;
+    description: string;
+};

package/types/assemble/url.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Parses a URL string and returns a URL object.
+ *
+ * @param url - The URL string to parse
+ * @returns A URL object containing the parsed components
+ */
+export declare function extractUrl(url: string): URL;
+/**
+ * Removes duplicate consecutive slashes from a path string.
+ *
+ * @param path - The path string to clean
+ * @returns The cleaned path with no consecutive slashes
+ */
+export declare function cleanPath(path: string): string;

package/types/assemble/xhr.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Performs a synchronous HTTP GET request to fetch HTML content from a URL.
+ *
+ * @param url - The URL to fetch content from
+ * @returns The HTML content as a string, or undefined if the request fails
+ */
+export declare function sync(url: string): string | undefined;
+/**
+ * Performs an asynchronous HTTP GET request to fetch HTML content from a URL.
+ *
+ * @param url - The URL to fetch content from
+ * @returns A Promise that resolves to the HTML content string
+ */
+export declare function async(url: string): Promise<string | undefined>;

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './link-to-card-plugin';
+export * from './types';

package/types/link-to-card-plugin.d.ts

@@ -0,0 +1,8 @@
+import type { LinkToCardPlugin } from './types';
+/**
+ * Markdown-it plugin that converts specially-formatted links into rich link preview cards.
+ *
+ * @param md - The markdown-it instance
+ * @param pluginOptions - Configuration options for the plugin
+ */
+export declare const linkToCardPlugin: LinkToCardPlugin;

package/types/types.d.ts

@@ -0,0 +1,124 @@
+import type MarkdownIt from 'markdown-it';
+/**
+ * Type definition for the link-to-card plugin compatible with markdown-it.
+ *
+ * @see {@link https://markdown-it.github.io/markdown-it/#MarkdownIt.use | MarkdownIt.use}
+ */
+export type LinkToCardPlugin = MarkdownIt.PluginWithOptions<LinkToCardPluginOptions>;
+/**
+ * Configuration options for the link-to-card plugin.
+ *
+ * This interface defines the customization options available when using the vitepress-linkcard plugin.
+ * The plugin converts specially-formatted markdown links (prefixed with `@:`) into rich link preview cards
+ * with Open Graph Protocol (OGP) metadata.
+ *
+ * @example
+ * ```typescript
+ * import { linkToCardPlugin } from 'vitepress-linkcard'
+ *
+ * markdownIt.use(linkToCardPlugin, {
+ *   target: '_blank'
+ * })
+ * ```
+ *
+ * @see {@link https://daringfireball.net/projects/markdown/syntax#link | Markdown Link Syntax}
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target | HTML anchor target attribute}
+ */
+export interface LinkToCardPluginOptions {
+    /**
+     * Where to display the linked URL.
+     * @defaultValue `'_blank'` - Opens the link in a new tab/window
+     */
+    target?: ATarget;
+    /**
+     * CSS class name prefix for the card DOM elements.
+     * When set, no inline styles are injected; only the class names are applied.
+     *
+     * @example `'my-docs__link-card'`
+     */
+    classPrefix?: string;
+    /**
+     * Custom function to render the DOM fragment for the link card.
+     * When provided, this function is used instead of the default card renderer.
+     */
+    render?: CardDomRender;
+}
+/**
+ * Metadata extracted from a URL's HTML page using Open Graph Protocol tags and meta tags.
+ *
+ * This interface represents the structured data fetched from a web page to populate the link card display.
+ * The metadata is typically extracted from `<meta>` tags, OGP tags, and other HTML elements.
+ *
+ * @see {@link https://ogp.me/ | Open Graph Protocol}
+ */
+export interface UrlMetadata {
+    /**
+     * The title of the page, extracted from `<title>` or `<meta property="og:title">` tags.
+     */
+    title?: string;
+    /**
+     * The description of the page, extracted from `<meta name="description">` or
+     * `<meta property="og:description">` tags.
+     */
+    description?: string;
+    /**
+     * The logo or icon URL for the page, extracted from `<meta property="og:image">` or
+     * `<link rel="icon">` tags.
+     */
+    logo?: string;
+    /**
+     * Additional metadata properties that may be extracted from the page.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Valid values for the HTML anchor element's `target` attribute.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target | MDN - target attribute}
+ */
+export type ATarget = '_self' | '_blank' | '_top' | '_parent';
+/**
+ * Options passed to the card DOM renderer function.
+ *
+ * This interface provides all the necessary information to render a link card,
+ * including the URL, display preferences, and styling options.
+ */
+export interface CardDomRenderOptions {
+    /**
+     * The URL to link to.
+     */
+    href: string;
+    /**
+     * The title text to display on the link (typically from the markdown link text).
+     */
+    linkTitle: string;
+    /**
+     * Where to display the linked URL when clicked.
+     */
+    target: ATarget;
+    /**
+     * CSS class name prefix for the card DOM elements.
+     */
+    classPrefix?: string;
+}
+/**
+ * Function signature for custom card DOM renderers.
+ *
+ * This type defines a function that takes URL metadata and rendering options,
+ * and returns an HTML string representing the link card.
+ *
+ * @param data - The metadata extracted from the URL
+ * @param options - Rendering and styling options for the card
+ * @returns An HTML string representing the rendered link card
+ *
+ * @example
+ * ```typescript
+ * const customRender: CardDomRender = (data, options) => {
+ *   return `<div class="${options.classPrefix}">
+ *     <h3>${data.title}</h3>
+ *     <p>${data.description}</p>
+ *   </div>`
+ * }
+ * ```
+ */
+export type CardDomRender = (data: UrlMetadata, options: CardDomRenderOptions) => string;