# @comark/nuxt 中文文档

规范地址：https://npmcn.com/package/%40comark/nuxt/

版本：0\.9\.0
npm 元数据更新时间：2026-11-06T14:19:45.630Z
中文译文更新时间：2026-11-10T11:30:45.229Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40comark/nuxt
原文对照：https://npmcn.com/package/%40comark/nuxt/?lang=original
项目主页：https://comark.dev/rendering/nuxt
源码仓库：https://github.com/comarkdown/comark

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

- 包体积（解压后）：13.7 kB，65 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：nuxt ^4\.6\.3
- 首次发布：2026-03-23T16:35:24.724Z
- 最新版本发布：2026-11-06T14:19:45.311Z
- 近 30 天下载量：123831（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

Comark的Nuxt模块. 在运行时带有组件的Render Markdown,拥有自动导入组件并流支持AI输出.

## 安装

```sh
npm install @comark/nuxt
```

也可以使用：`pnpm add @comark/nuxt`、`yarn add @comark/nuxt`、`bun add @comark/nuxt`

## README

![Comark banner](https://github.com/comarkdown/comark/blob/main/assets/banner.jpg)

# @ comark/ nuxt

[![npm version](https://img.shields.io/npm/v/@comark/nuxt?color=black)](https://npmx.dev/@comark/nuxt) [![npm downloads](https://img.shields.io/npm/dm/@comark/nuxt?color=black)](https://npm.chart.dev/@comark/nuxt) [![CI](https://img.shields.io/github/actions/workflow/status/comarkdown/comark/ci.yml?branch=main&color=black)](https://github.com/comarkdown/comark/actions/workflows/ci.yml) [![Documentation](https://img.shields.io/badge/Documentation-black?logo=readme&logoColor=white)](https://comark.dev/rendering/nuxt) [![license](https://img.shields.io/github/license/comarkdown/comark?color=black)](https://github.com/comarkdown/comark/blob/main/LICENSE)

0-配置 Nuxt 模块 [标记](https://comark.dev/)一个高性能的分解和渲染器.

## 特征

-   自动进口 `<Markdown>` 财务报告和审定财务报表 `<MarkdownDocument>` 组件
-   📁 `~/components/prose` 压倒性的 HTML 元素目录
-   自动 [Nuxt 用户界面](https://ui.nuxt.com/) 传教融合
-   ++ SSR, SSG, 并预发支持出框
-   🧩 Comark 插件的再出口(绑定、数学、美人鱼)
-   QQ 全类型脚本支持

## 安装

### 自动

添加 `@comark/nuxt` 你的项目。 安装依赖性并注册模块 `nuxt.config.ts`数字 :

```bash
npx nuxt add comark
```

### 手动

添加 `@comark/nuxt` 对您的依赖:

```bash
npm install @comark/nuxt
# or
pnpm add @comark/nuxt
```

那就加进你的 `nuxt.config.ts`数字 :

```ts
export default defineNuxtConfig({
  modules: ['@comark/nuxt'],
})
```

## 使用量

这个 `<Markdown>` 全球可提供组件,不需要进口。 通过默认槽或标记 `value` 道具 :

```vue
<script setup lang="ts">
const content = `# Hello Nuxt\n\nRendered with **Comark**.`
</script>

<template>
  <Markdown>{{ content }}</Markdown>
</template>
```

### 自定义组件

将 Comark 标记映射到您的 Vue 组件 :

```vue
<script setup lang="ts">
import Alert from '~/components/Alert.vue'
</script>

<template>
  <Markdown :components="{ alert: Alert }">{{ content }}</Markdown>
</template>
```

```mdc
::alert{type="warning"}
This is a warning.
::
```

### 覆盖 HTML 元素

将组件丢入 `~/components/prose` 以覆盖本地 HTML 元素如何渲染。 它们是自动登记的:

```
~/components/prose/
  ProseH1.vue
  ProsePre.vue
  ProseA.vue
```

### 插件

```vue
<script setup lang="ts">
import math, { Math } from '@comark/nuxt/plugins/math'
import mermaid, { Mermaid } from '@comark/nuxt/plugins/mermaid'
</script>

<template>
  <Markdown
    :components="{ math: Math, mermaid: Mermaid }"
    :plugins="[math(), mermaid()]"
  >
    {{ content }}
  </Markdown>
</template>
```

### Nuxt 用户界面

何时 [`@nuxt/ui`](https://ui.nuxt.com/) 安装后, 传言组件自动被接通 :

```ts
export default defineNuxtConfig({
  modules: ['@comark/nuxt', '@nuxt/ui'],
})
```

## 文档

完整指南和 API 参考 [comark.dev/上交/nuxt (韩语)](https://comark.dev/rendering/nuxt)。 。 。 .

## 代理技能

编码代理可以从 Docs 站点安装 Comark 技能 :

```bash
npx skills add https://comark.dev
```

## 许可证

由 所制

原载 [MIT 许可证](https://github.com/comarkdown/comark/blob/main/LICENSE)。 。 。 .

## 常见问题

### @comark/nuxt 是什么？

Comark的Nuxt模块\. 在运行时带有组件的Render Markdown,拥有自动导入组件并流支持AI输出\.

### 如何安装 @comark/nuxt？

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

### @comark/nuxt 支持 TypeScript 吗？

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

### @comark/nuxt 支持 ESM 还是 CommonJS？

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

### @comark/nuxt 可以商用吗？

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

### @comark/nuxt 的下载量有多少？

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

### @comark/nuxt 还在维护吗？

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