# @gluhar/studio 中文文档

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

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

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

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

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

- 包体积（解压后）：126 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：react ^19\.2，sanity ^6\.4\.0，react-dom ^19\.2，styled-components ^6\.1
- 首次发布：2026-10-20T18:07:00.609Z
- 最新版本发布：2026-11-16T12:47:23.839Z
- 近 30 天下载量：2780（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

与Gluhar Studios共享的"Sanity Studio"插件:字段级的i18n类型,丰富的文本,链接,SEO,流星,单子,媒体,语言过滤器,以及内容注册处的演示.

## 安装

```sh
npm install @gluhar/studio
```

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

## README

# `@gluhar/studio`

Sanity Studio插件 配有Gluhar Studios分享的所有东西. 它取代了手抄本 `schemas/gluhar/` 文件夹和 `src/` 每个项目的助手。 卫生 **6个**,反应19.

```ts
// sanity/sanity.config.ts
import { defineConfig } from 'sanity'
import { structureTool } from 'sanity/structure'
import { gluhar } from '@gluhar/studio'
import { locales, defaultLocale } from '../config/i18n.config'

export default defineConfig({
  ...api,
  plugins: [
    structureTool({ structure }),
    gluhar({
      locales,
      defaultLocale,
      singletons: { types: ['header', 'footer', 'defaultSeo'], ids: ['homepage'] },
      page: { sections: ['hero', 'textSection'] },
    }),
  ],
  schema: { types: projectSchemas },
})
```

那个工作室的 `package.json` 必须 **声明** `sanity`, (中文(简体) ), `react`, (中文(简体) ), `react-dom` 财务报告和审定财务报表 `styled-components` 本身(Sanity CLI检查申报,而不仅仅是安装).

## 什麽 `gluhar()` 登记册

| 类型 |  |
| --- | --- |
| `localeString` `localeText` `localeBlock` `localeBlockParagraphs` | 字段级别 i18n, 每个地块一个字段( 读取 `l()` (现场) |
| `richtext` | 便携式文本:普通/h2-h4,强/em/出击/突出,链接注释,以及 `image` (备选案文、标题、热点), `videoFile`, (中文(简体) ), `videoEmbed` (YouTube语), `table`。如果有 2+ 区域,每个区域有一个阵列 |
| `paragraphs` | 只有标记的文字——没有样式,没有块 |
| `link` `nestedLink` | 页面参考 `linkTypes`默认值 `['page']`)或自定义 URL; 名称、 新标签、 查询参数 |
| `seo` `defaultSeo` | 标题、描述、 OG 图像 |
| `gluharSlug` `uid` | 从默认- locale 名称生成 sult; 稳定的密钥, “ Generate from Name ” |
| `faq` `location` |  |
| `page` | 仅在 `page` ——或从 `pageFields()` |

加:单通处理(没有"创建",只发布/丢弃/还原), **智取-插件-媒体**,以及 **@ saniity/ 语言过滤器** 打开 `locale*` 字段(2+ locates)。 关闭任何与 `media: false`, (中文(简体) ), `languageFilter: false`, (中文(简体) ), `richText: false`。 。 。 . **@ sanity/ vision (英语)** 默认关闭; 添加到 `vision: true`。 。 。 .

内容发布和排期草稿留在项目 `defineConfig`,而不是插件。 危险读取 `releases.enabled` 仅从工作空间配置,所以插件无法关闭 。 启动器同时禁用 :

```ts
export default defineConfig({
  // ...
  releases: { enabled: false },
  scheduledDrafts: { enabled: false },
})
```

项目保持自己的计划 `structure`。删除项目上所有内容的副本,否则“Sanity”报告重复类型.

## 列报`presentation()`(中文(简体) )

从网站内容登记册接通的视觉编辑(`config/content.config.ts`,参见 `@gluhar/routes`),这样 `mainDocuments` 财务报告和审定财务报表 `locations` 与站点路由器保持同步:

```ts
import { createContentRoutes, documentUrl, gluhar, presentation } from '@gluhar/studio'
import registry from '../config/content.config'
import { locales, defaultLocale } from '@locale-config'

const routes = createContentRoutes(registry, { locales, defaultLocale })

export default defineConfig({
  plugins: [
    structureTool({ structure, defaultDocumentNode }),
    presentation({ routes, origin: process.env.SANITY_STUDIO_PREVIEW_URL || 'http://localhost:3000' }),
    gluhar({ locales, defaultLocale /* … */ }),
  ],
})
```

-   `mainDocuments`: 每一个路由类型在其前缀,每个地块,先被前缀的地块(所以) `/:slug` 不吞东西 `/en`); 默认类型的主页 `homeSlug`。 。 。 .
-   `locations`: 每个地方中每个路由文档(“Name-EN”),标题来自 `name.<defaultLocale>` (单位:千美元)`titleField` 页:1.
-   `previewMode` 默认为 @ nuxtjs/ saniity 的 `/preview/enable` + 键 `/preview/disable`。任何其他 `presentationTool` 选项通过.
-   前缀是登记簿的文字(工作室无法读取 uid ~ sult 映射):重新命名索引页并更新其内容 `prefix`。 。 。 .
-   `documentUrl(routes, origin)` → `(doc) => url`,用于预览窗格(`sanity-plugin-iframe-pane`是因为 `url`) (中文(简体) ). 没有 `?preview=true`: 草稿只显示预览会话, 演示文稿设置.

如果工作室导入 `config/content.config.ts` 财务报告和审定财务报表 `config/i18n.config.ts` 从项目,保留两个平坦的静态模块:它们被捆绑入工作室.

## 丰富文本

这个 `richtext` 块类型 (`richTextTypes`与 `@gluhar/sanity`制造器 重命名一个 并且它不会在现场制造任何东西 备选案文:

```ts
import { defineRichText } from '@gluhar/studio'

defineRichText({ name: 'articleBody', styles: ['normal', 'h2', 'h3'], types: ['image', 'table'] }, locales)
```

## 帮助者

-   `pageFields({ defaultLocale, sections })`, (中文(简体) ), `pagePreview(defaultLocale)` ——组成项目特有页面类型.
-   `singletonItem(S, { id, title, icon })` ——单子结构的一半.
-   `generateKeyFrom('name.bg')`, (中文(简体) ), `LocaleStringSameAs`, (中文(简体) ), `HighlightDecorator` ——投入.
-   `isUniqueAcrossAllDocuments` - 各种类型的弹道独特性(`options.isUnique`) (中文(简体) ).

## 发展

`npm run build` · (pkg-utils) `npm run typecheck` 游乐场: `cd playground && npx sanity schema validate && npx sanity build`。 。 。 .

pkg-utils被钉入 **10.x 电话** ——11+需要TypeScript 6,而Nuxt模块的构建器仍然需要5.9.

## 常见问题

### @gluhar/studio 是什么？

与Gluhar Studios共享的"Sanity Studio"插件:字段级的i18n类型,丰富的文本,链接,SEO,流星,单子,媒体,语言过滤器,以及内容注册处的演示\.

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

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

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

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

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

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

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

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

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

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

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

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

