# comark-embed 中文文档

规范地址：https://npmcn.com/package/comark-embed/

版本：0\.9\.0
npm 元数据更新时间：2026-11-03T06:23:52.402Z
中文译文更新时间：2026-11-03T09:05:25.502Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/comark-embed
原文对照：https://npmcn.com/package/comark-embed/?lang=original
项目主页：https://comark-ui.onmax.me/embed
源码仓库：https://github.com/onmax/comark-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：48.5 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：0 个
- peer 依赖：vue \>=3\.5，react \>=18，comark ^0\.8\.0，svelte \>=5，@comark/html ^0\.8\.0
- 首次发布：2026-10-21T07:57:56.262Z
- 最新版本发布：2026-11-03T06:23:52.088Z
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

视频，音频和工具嵌入从一个链接：YouTube， Vimeo, Loom, Spotify, CodePen, StackBlitz， Figma和X，没有网络获取。一个Comark插件。

## 安装

```sh
npm install comark-embed
```

也可以使用：`pnpm add comark-embed`、`yarn add comark-embed`、`bun add comark-embed`

## README

# comark-embed

[![npm version](https://comark-ui.onmax.me/badge.svg?source=npm-version&package=comark-embed&icon=npm)](https://npmx.dev/package/comark-embed) [![npm downloads](https://comark-ui.onmax.me/badge.svg?source=npm-downloads&package=comark-embed&period=month&icon=npm)](https://npmx.dev/package/comark-embed) [![license](https://comark-ui.onmax.me/badge.svg?label=license&value=MIT)](https://npmx.dev/package/comark-embed) [![docs](https://comark-ui.onmax.me/badge.svg?label=docs&value=comark-ui.onmax.me)](https://comark-ui.onmax.me/embed/)

视频，音频和实时代码从一个链接：YouTube， Vimeo, Loom, Spotify, CodePen, StackBlitz, Figma，和X播放器，从链接单独读取，没有网络获取。一个 [Comark](https://comark.dev/) HTML, Vue， React和Svelte插件。

```sh
pnpm add comark comark-embed
```

```ts
import { createHtmlRenderer } from "@comark/html";
import embed, { components } from "comark-embed/html";

const render = createHtmlRenderer({ plugins: [embed()], components });
```

```md
::embed{url="https://youtu.be/KCrXgy8qtjM" title="Watch before standup: Vite in 100 Seconds" start=30}
::

::embed{url="https://comark.dev" title="Comark docs, for the duck report"}
::
```

`url` 一定是。 `https://` 链接。 `title` 命名播放器和它下面的链接的文本，这使页面在打印，提要阅读器和iframe被阻止的地方可读。 `start` 是YouTube或Vimeo视频的几秒钟。用 `::` 下一行。

| 提供者 | 链接上面写着 |
| --- | --- |
| YouTube | `youtube.com/watch?v=`， `youtu.be/`， `/shorts/`， `/embed/`， `/live/`;戏剧从 `youtube-nocookie.com` |
| Vimeo | `vimeo.com/<number>`，未列出的链接及其散列；玩 `dnt=1` |
| 织机 | `loom.com/share/<id>`， `/embed/<id>` |
| Spotify | `open.spotify.com/` 曲目，专辑，播放列表，剧集，节目和艺术家 |
| CodePen | `codepen.io/<user>/pen/<id>` (也 `full`， `details`,或 `embed`） |
| StackBlitz | `stackblitz.com/edit/<project>`， `stackblitz.com/github/<owner>/<repo>[/<path>]` |
| Figma | `figma.com/design`， `file`， `proto`， `board`， `slides`, `deck` |
| X | `x.com/<user>/status/<id>`， `twitter.com`, `mobile.` 链接;长到柱子的高度 |

任何其他 `https://` 链接呈现为带有其 `title` 和主机。卡片还不能获取页面标题，所以给每个卡片一个 `title`。

插件增加了每一个问题 `meta.issues`，因此主机可以在发布文档之前拒绝该文档。一个 `url` 这不是 `https://` 呈现。

## 渲染器

| 渲染器 | 进口 |
| --- | --- |
| `@comark/html` | `comark-embed/html`：样式是内联的 |
| `@comark/vue` | `comark-embed/vue` |
| `@comark/react` | `comark-embed/react` |
| `@comark/svelte` | `comark-embed/svelte` |

每个条目将解析插件导出为 `default` 还有渲染器 `components`． Vue、React和Svelte组件在挂载时添加样式；进口 `comark-embed/style.css` 使用您的样式，使服务器呈现的页面不会移位。

样式遵循shadcn/ui：它们读取它的CSS变量，例如 `--background` 和 `--border`，否则使用它的中性主题。设置共享 `--comark-*` 令牌主题每个插件一次；规则放在 `comark` CSS层，所以任何简单的规则你自己的胜利。覆盖 `--ce-app-height` 改变CodePen， StackBlitz和Figma的高度；见嵌入 [主题页面](https://comark-ui.onmax.me/embed/#theme)。

## 常见问题

### comark-embed 是什么？

视频，音频和工具嵌入从一个链接：YouTube， Vimeo, Loom, Spotify, CodePen, StackBlitz， Figma和X，没有网络获取。一个Comark插件。

### 如何安装 comark-embed？

在项目目录运行 npm install comark-embed，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：comark（^0\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### comark-embed 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### comark-embed 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### comark-embed 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### comark-embed 可以商用吗？

comark-embed 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### comark-embed 还在维护吗？

最新版本 0\.9\.0 发布于 2026/11/03（今天）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。