简介
hub-externally-embedded-widget 是一款能够让用户在自己的网站或应用中嵌入项目页面的 npm 包。用户可以通过该包在自己的网站或应用中，以 iframe 的方式嵌入 GitHub 项目页面或 Gist 页面。该包是基于 Github 官方提供的嵌入组件开发的，支持 Markdown 渲染及语法高亮等功能。
安装
要安装 hub-externally-embedded-widget 包，您需要在本地安装 Node.js 环境。在安装完成之后，您可以使用以下命令进行安装：
npm install hub-externally-embedded-widget
使用
嵌入 GitHub 项目页面
要嵌入 GitHub 项目页面，您需要使用 embedRepo 函数。该函数允许您传递一些参数，以及项目所在的 GitHub 用户名和存储库名称。下面是一个基本示例：
-- -------------------- ---- -------
---- -----------------------------
------- ----------------------------------------------------------
--------
----- ------- - -
------ ------ -- ------ ---
----- ------ -- -----
---- ------- -- ----
--------- ---------- -- ----
--
------------------------------------------------------------ ---------
---------嵌入 Gist 页面
要嵌入 Gist 页面，您需要使用 embedGist 函数。该函数允许您传递一些参数，以及 Gist 的 ID。下面是一个基本示例：
-- -------------------- ---- -------
---- -----------------------------
------- ----------------------------------------------------------
--------
----- ------- - -
----- ---------------------- -- ---- --
--
------------------------------------------------------------ ---------
---------参数说明
embedRepo
options.owner(string) — GitHub 用户名。options.repo(string) — 存储库名称。options.ref(string) — 分支名称。options.filePath(string) — 文件路径。
embedGist
options.gist(string) — Gist ID。
总结
hub-externally-embedded-widget 是一个非常便于使用的 npm 包，可以帮助开发人员快速地将 GitHub 项目页面或 Gist 页面嵌入到他们的网站或应用中。该包支持多种参数配置，可以很方便地进行定制化开发。如果您需要将项目页面或 Gist 页面嵌入到您的网站或应用中，请不要忘记尝试一下这个便捷的 npm 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006735a890c4f7277583ece