# @create-markdown/preview 中文文档

规范地址：https://npmcn.com/package/%40create-markdown/preview/

版本：2\.0\.3
npm 元数据更新时间：2026-04-09T16:53:13.748Z
中文译文更新时间：2026-11-10T23:48:03.952Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40create-markdown/preview
原文对照：https://npmcn.com/package/%40create-markdown/preview/?lang=original
项目主页：https://github.com/BunsDev/create-markdown/tree/main/packages/preview
源码仓库：https://github.com/BunsDev/create-markdown

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

- 包体积（解压后）：416 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- peer 依赖：@create-markdown/core \>=2\.0\.3，shiki \>=1\.0\.0
- 首次发布：2026-01-28T00:32:16.104Z
- 最新版本发布：2026-04-09T16:53:13.638Z
- 近 30 天下载量：159114（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

框架- 不可知 HTML 渲染为 @ create- markdown 有可选语法突出显示

## 安装

```sh
npm install @create-markdown/preview
```

也可以使用：`pnpm add @create-markdown/preview`、`yarn add @create-markdown/preview`、`bun add @create-markdown/preview`

## README

# @ 创建- markdown/ 预览

框架- 不可知 HTML 渲染为 @ create- markdown 有语法加亮( Shiki) 和图支持( Mermaid) .

## 安装

```bash
# Using pnpm
pnpm add @create-markdown/preview

# Using npm
npm install @create-markdown/preview

# Optional: Install plugins
pnpm add shiki
```

## 快速启动

### 基本 HTML 渲染

```typescript
import { markdownToHTML } from '@create-markdown/preview';
import DOMPurify from 'dompurify';

const html = await markdownToHTML(`
# Hello World

This is **bold** and *italic* text.
`);

const preview = document.getElementById('preview');

if (preview) {
  preview.innerHTML = DOMPurify.sanitize(html, { USE_PROFILES: { html: true } });
}
```

在渲染之前先对不可信的内容进行无害化处理. 直接 DOM 任务只有在完全信任下标源时才合适 .

### 带有语法加亮 (Shiki)

```typescript
import { renderAsync, shikiPlugin } from '@create-markdown/preview';
import { parse } from '@create-markdown/core';

const blocks = parse(`
\`\`\`typescript
const greeting = "Hello, World!";
console.log(greeting);
\`\`\`
`);

const html = await renderAsync(blocks, {
  plugins: [shikiPlugin({ theme: 'github-dark' })],
});
```

### 有美人鱼图

```typescript
import { renderAsync } from '@create-markdown/preview';
import { mermaidPlugin } from '@create-markdown/preview-mermaid';
import { parse } from '@create-markdown/core';

const blocks = parse(`
\`\`\`mermaid
flowchart LR
  A[Start] --> B[Process]
  B --> C[End]
\`\`\`
`);

const html = await renderAsync(blocks, {
  plugins: [
    mermaidPlugin({
      theme: 'default',
      config: { securityLevel: 'strict' },
    }),
  ],
});
```

仅在需要时安装人鱼支持 :

```bash
pnpm add @create-markdown/preview-mermaid mermaid
```

在图文可以来自用户时使用美人鱼更严格的安全模式. 只为完全信任的内容选择松散的美人鱼设置 .

### 网络组件

```html
<script type="module">
  import { registerPreviewElement } from '@create-markdown/preview';
  registerPreviewElement();
</script>

<markdown-preview theme="github">
# Hello World

This is rendered as HTML automatically!
</markdown-preview>
```

带有插件 :

```typescript
import { registerPreviewElement, shikiPlugin } from '@create-markdown/preview';
import { mermaidPlugin } from '@create-markdown/preview-mermaid';

registerPreviewElement({
  plugins: [
    shikiPlugin(),
    mermaidPlugin(),
  ],
});
```

网络组件默认会让可信内容生效,因此在将用户提供的标记传递给元素之前,先对用户提供的标记进行消毒.

## API 密码

### `blocksToHTML(blocks, options?)`

将块同步转换为 HTML 字符串 .

### `markdownToHTML(markdown, options?)`

将下标字符串转换为 HTML .

### `renderAsync(blocks, options?)`

在渲染前初始化插件的Async版本.

### 插件

-   `shikiPlugin(options?)` - 与Shiki一起突出语法
-   `mermaidPlugin(options?)` - 美人鱼图透视 `@create-markdown/preview-mermaid`

### 主题

CSS主题见:

-   `@create-markdown/preview/themes/github.css`
-   `@create-markdown/preview/themes/github-dark.css`
-   `@create-markdown/preview/themes/minimal.css`

## 选项

```typescript
interface PreviewOptions {
  classPrefix?: string;       // CSS class prefix (default: 'cm-')
  theme?: string;             // Theme name
  linkTarget?: '_blank' | '_self';
  sanitize?: boolean | ((html: string) => string);
  plugins?: PreviewPlugin[];  // Plugins for enhanced rendering
}
```

## 许可证

麻省理工学院

## 常见问题

### @create-markdown/preview 是什么？

框架- 不可知 HTML 渲染为 @ create- markdown 有可选语法突出显示

### 如何安装 @create-markdown/preview？

在项目目录运行 npm install @create-markdown/preview，或使用 pnpm add / yarn add / bun add。

### @create-markdown/preview 支持 TypeScript 吗？

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

### @create-markdown/preview 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @create-markdown/preview 需要什么版本的 Node\.js？

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

### @create-markdown/preview 可以商用吗？

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

### @create-markdown/preview 的下载量有多少？

根据 npm 官方下载统计，@create-markdown/preview 在 2026/10/11 – 2026/11/09 这 30 天内被下载 159,114 次，日均约 5,304 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @create-markdown/preview 还在维护吗？

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