bytemd插件开发–将链接渲染为卡片模式

💡 原文中文,约11500字,阅读约需28分钟。
📝

内容提要

本文介绍了如何使用语雀这一在线文档编辑网站将超链接渲染为卡片样式。通过请求目标网页的index.html,获取关键信息后渲染为卡片样式。使用puppeteer获取目标网站信息,通过express搭配puppeteer实现。在渲染卡片链接时,先将链接渲染为骨架屏的卡片样式,增强交互体验。通过IntersectionObserver实现链接的懒渲染。最后,介绍了插件的打包和发布过程。

🔎

延伸解读

跨域限制与后端代理的必要性

文章指出,直接使用fetch请求目标网页会因同源策略而跨域失败。因此,必须通过后端服务(如Express)搭配Puppeteer来获取网页信息。这提醒开发者,在实现类似功能时,需考虑跨域问题,并部署相应的后端接口,而不能仅依赖前端代码。

懒渲染与性能优化

为避免页面加载时同时请求所有链接信息导致服务器压力过大和页面卡顿,文章采用IntersectionObserver实现懒渲染。仅当链接进入可视区域时才触发请求和渲染,并设置rootMargin作为缓冲区。这能有效提升页面性能,尤其适用于链接较多的文档。

超时与默认值处理

由于网络延迟或目标网站无相关meta标签,请求可能超时或获取不到信息。文章建议设置请求超时(如25秒),超时后使用默认值(如默认图标、标题“无标题”)渲染,并忽略后续响应。这保证了卡片始终能显示,避免界面空白或错误。

插件配置的灵活性

插件提供了多项配置,如自定义请求接口、超时时间、默认图标、打开方式、排除链接等,用户可根据需要调整。这增强了插件的通用性,使其能适应不同场景。开发者在使用时,应合理配置这些选项以平衡功能与性能。

❓

Q&A

如何使用语雀将超链接渲染为卡片样式?

通过请求目标网页的index.html获取关键信息,然后使用puppeteer和express实现渲染。

puppeteer在获取网页信息时有什么优势?

puppeteer可以在后端环境中以chrome浏览器的形式加载网页,能够处理跨域问题。

如何处理请求超时或获取不到信息的情况?

可以使用默认值进行渲染,并设置请求超时,超过时间直接使用默认值。

如何实现链接的懒渲染?

使用IntersectionObserver API监听链接元素的可见性,只有在可视区域内才触发渲染。

插件的打包和发布过程是怎样的?

使用rollup进行打包,配置相关插件后执行npm publish发布到npm。

用户可以自定义哪些插件配置?

用户可以自定义请求接口、超时设置、默认icon链接等多个配置项。

🏷️

标签

➡️

继续阅读