# @gluhar/sanity 中文文档

规范地址：https://npmcn.com/package/%40gluhar/sanity/

版本：6\.4\.1
npm 元数据更新时间：2026-11-16T12:44:07.893Z
中文译文更新时间：2026-11-16T16:53:54.807Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gluhar/sanity
原文对照：https://npmcn.com/package/%40gluhar/sanity/?lang=original
项目主页：https://github.com/gluharco/gluhar#readme
源码仓库：https://github.com/gluharco/gluhar

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

- 包体积（解压后）：83.5 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：12 个
- peer 依赖：nuxt ^4\.6\.2
- 首次发布：2025-01-21T20:29:18.409Z
- 最新版本发布：2026-11-16T12:44:07.705Z
- 近 30 天下载量：3060（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 28 个）

## 中文简介

格卢哈尔卫生套餐. 在引擎盖下配置@nuxtjs/ saniity. 提供可堆肥等,取决于@gluhar/i18n的田地本地化.

## 安装

```sh
npm install @gluhar/sanity
```

也可以使用：`pnpm add @gluhar/sanity`、`yarn add @gluhar/sanity`、`bun add @gluhar/sanity`

## README

# `@gluhar/sanity`

[![npm version](https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82)](https://npmjs.com/package/my-module) [![npm downloads](https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82)](https://npmjs.com/package/my-module) [![License](https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82)](https://npmjs.com/package/my-module) [![Nuxt](https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js)](https://nuxt.com/)

格卢哈尔卫生套餐. 在引擎盖下配置@nuxtjs/ saniity. 提供可堆肥等.

取决于 @gluhar/i18n 的字段本地化,所以您需要安装和配置 `@gluhar/i18n` 以便使用理智模块.

[QQ 发布注释](https://npmcn.com/CHANGELOG.md)

## 安装

用一个命令将模块安装到您的 Nuxt 应用程序 :

```bash
npx nuxi module add @gluhar/sanity
```

## 圣洁配置

在您的 / 配置文件夹中创建一个 `sanity.config.ts` 用于配置 gluhar 模块和 `@nuxtjs/sanity` 使用幕后画面.

更新 ID 指向您的工程和 apiVersion 到今天的日期 .

```ts
export default {
  projectId: "8m33196t",
  apiVersion: "2024-04-01",
  dataset: "production",
};
```

软件包会自动加载此文件, 并进行其余的工作 。 如果您需要更多自定义配置, 您可以使用模块密钥 `gluharSanity`。 。 。 .

## 使用量

您可以从 `@gluhar/sanity/types` 例如 `SanityDocument`, (中文(简体) ), `SanityImage`, (中文(简体) ), `SanityPage`。 。 。 .

最常用的查询来自 `@gluhar/sanity/query` 喜欢 `imageWithAsset`

### ISR、预览和视觉编辑`isr`(中文(简体) )

在Vercel上点取带有 " Sanity " 预览的ISR,从光学-com(生产-检查)和Cosopethrace上取出。 打开内容注册和两个查询:

```ts
// nuxt.config.ts
gluhar: {
  sanity: {
    isr: { noindex: ["/internal/**"] }, // or `isr: true`
  },
},
```

```ts
// config/content.config.ts — shared with the Studio, plain data only
import { defineContentRegistry } from "@gluhar/routes";

export default defineContentRegistry({
  types: [
    { type: "page", homeSlug: "/" },
    { type: "article", prefix: "news", prefixUid: "news" },
  ],
  aggregators: ["/", "/news"],
  globalTypes: ["header", "footer", "settings", "defaultSeo"],
  appPaths: ["/login"],
});
```

```ts
// groq/index.ts
export const queryForType = (type: ContentDocumentType) => QUERY_BY_TYPE[type]; // $slug param
export const globalsQuery = groq`{ "header": *[_id == "header"][0]{ ... }, ... }`;
```

```vue
<!-- app.vue -->
<script setup lang="ts">
const { data: globals } = await useGlobals<Globals>();
</script>

<!-- pages/[...slug].vue -->
<script setup lang="ts">
const { page, status, upstreamFailed } = await useSinglePage<Page | Article>();
</script>
<template>
  <NotFound v-if="!page && status !== 'pending'" :code="upstreamFailed ? 503 : 404" />
  <Sections v-else-if="page?._type === 'page'" :sections="page.sections" />
  <ArticleDetail v-else-if="page?._type === 'article'" :article="page" />
</template>
```

它的设置:

|  |  |
| --- | --- |
| 路由规则( 仅构建) | `/**` 简要记录 `allowQuery: []`· ; `/api/**`, (中文(简体) ), `/preview/**` 未涂上; `/sitemap.xml` 简要记录 没有先交的 |
| `GET /api/page?type&slug` | 路由文件; `null` ^ 404, 读取失败 ^ 503 |
| `GET /api/globals` | `globalsQuery` + 键 `pageSlugsByUid`一个读 |
| `POST /api/revalidate` | 圣洁的网点( 下方) |
| `/api/__sitemap__/urls` | 添加到 `sitemap.sources` 何时 `@nuxtjs/sitemap` 已安装 : 注册类型 × 有 hreflang 的地块 |
| 预览 | `__prerender_bypass` 打开 `/preview/enable` **之后** 秘密的证据; `/preview/disable?redirect=` 限于此站点; 草稿仅与已验证的 `sanity-preview-id` 饼干 **财务报告和审定财务报表** `?preview=true` |
| `@nuxtjs/sanity` | `perspective: "published"` (强制:"raw"+服务器令牌服务草稿),,, `useCdn: false`页:1 `drafts` 客户端有 stega 和一个字段过滤器, `visualEditing.stega: false` (强制),在 Studio 编辑时进行就地刷新 |
| Vercel 边缘 | `bypassToken`· ; `noindex` 在不可索引的建筑物上, `isr.noindex` 路径和 `_payload.json` (加上功能上,由@nuxtjs/robots取而代之);308用于后行鞭打 |
| 可编曲 | `useSinglePage<T>()`, (中文(简体) ), `useGlobals<T>()`, (中文(简体) ), `contentRoutes` (也在服务器上) |
| 服务器已使用 | `getPage`, (中文(简体) ), `getGlobals`, (中文(简体) ), `fetchPublished`, (中文(简体) ), `fetchDrafts`, (中文(简体) ), `fetchContentPaths`, (中文(简体) ), `isPreviewRequest`, (中文(简体) ), `hasPreviewSession` |
| 建立警卫 | `VERCEL_BYPASS_TOKEN` 现在和URL安全, `NUXT_SANITY_STUDIO_URL` 设定而非 `*.sanity.studio` 主机( Vercel 上的错误, 警告) ; 空的预发器, `payloadExtraction` 非虚假( 到处都是错误) |

信封 : `NUXT_SANITY_TOKEN` (读出信条;草稿), `NUXT_SANITY_STUDIO_URL` (工作室解决的URL, `https://www.sanity.io/@<org>/studio/<appId>`, (中文(简体) ), `VERCEL_BYPASS_TOKEN` (单位:千美元)`openssl rand -hex 16`时需要 **构建**, (中文(简体) ), `REVALIDATE_SECRET`。 。 。 .

选项 : `registry` (默认) `config/content.config`, (中文(简体) ), `queries` (单位:千美元)`groq`, (中文(简体) ), `expiration`, (中文(简体) ), `noindex`, (中文(简体) ), `indexable` (默认) `site.indexable`,则 `VERCEL_ENV === "production"`, (中文(简体) ), `stripTrailingSlash`, (中文(简体) ), `concurrency`, (中文(简体) ), `stega.logicFields` 编号 : `stega.nonTextFields` (加进 `uid key slug current oldSlug` 编号 : `alt orderRank`; 任意字段 `options.list` 是一个逻辑领域),并且 `handlers.{page,globals,revalidate,sitemap,preview}: false` 保持一个项目自己的.

**网瘾** (Sanity ~ API ~ Webhooks),创建/更新/删除,草稿删除,页眉 `x-revalidate-secret: <REVALIDATE_SECRET>`数字 :

```
filter:     _type in [<registry types>, <globalTypes>]
projection: { _type, "slug": slug.current, "oldSlug": before().slug.current }
```

更改会清除文档的 URL( 以及它空出的一个), 集合器和站点映像, 在每个地方, 每个页面的 `_payload.json`。一个全局类型或弹道变化可以清除每条路线。 项目规则用 Nitro 插件 :

```ts
// server/plugins/revalidate.ts
export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook("gluhar:revalidate", (ctx) => {
    if (ctx.doc._type === "promotion" && ctx.doc.accent) ctx.global = true; // add "accent" to the projection
    if (ctx.doc._type === "tvChannel") ctx.paths.add("/tv");
  });
});
```

这些都没有在 Dev 服务器( Plain SSR) 上活动, 也没有一个可以在那里验证的: 请检查 Vercel 部署(`x-vercel-cache`,来自演示文稿的预览,一个webhook快递).

`useSanityQueryWithPreview` (和 `@gluhar/app`是因为 `useSanityPage`)被贬值:它们在浏览器中获取并处理 `?preview` 作为预览.

### 丰富文本

`<RichText>` 使 `richtext` 编号 : `paragraphs` 类型来源 `@gluhar/studio`。按原样通过本地化的字段(它称为 `l()`),或平面阵列:

```vue
<RichText
  :value="article.body"
  :classes="{
    normal: 'mt-5 fl-text-lg leading-relaxed',
    h2: 'mt-10 mb-4 fl-text-2xl font-extrabold',
    highlight: 'bg-amber-100',
    link: 'text-blue-700 underline',
  }"
  image-sizes="(min-width: 75rem) 50vw, 100vw"
/>
```

-   `classes`: 每个元素的功用类别。 键替换默认值,并且 `""` 将取去. 密钥 : `normal` `large` `h2` `h3` `h4` `blockquote` `ul` `ol` `li` `strong` `em` `underline` `strike-through` `highlight` `link` `figure` `img` `figcaption` `video` `embed` `table` `th` `td`。 。 。 .
-   `components`数字 : `@portabletext/vue` 组件在默认情况下合并,按密钥计算.
-   `image-sizes`页:1 `sizes` 图像属性( 默认) `100vw`) (中文(简体) ).

GROQ 需要没有 `asset->`: 图像和文件从 `asset._ref`。 。 。 .

## 捐款

地方发展

```bash
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release
```

## 常见问题

### @gluhar/sanity 是什么？

格卢哈尔卫生套餐\. 在引擎盖下配置@nuxtjs/ saniity\. 提供可堆肥等,取决于@gluhar/i18n的田地本地化\.

### 如何安装 @gluhar/sanity？

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

### @gluhar/sanity 支持 TypeScript 吗？

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

### @gluhar/sanity 支持 ESM 还是 CommonJS？

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

### @gluhar/sanity 可以商用吗？

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

### @gluhar/sanity 的下载量有多少？

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

### @gluhar/sanity 还在维护吗？

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

