@gluhar/studio
Sanity Studio插件 配有Gluhar Studios分享的所有东西. 它取代了手抄本 schemas/gluhar/ 文件夹和 src/ 每个项目的助手。 卫生 6个,反应19.
// 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 仅从工作空间配置,所以插件无法关闭 。 启动器同时禁用 :
export default defineConfig({
// ...
releases: { enabled: false },
scheduledDrafts: { enabled: false },
})
项目保持自己的计划 structure。删除项目上所有内容的副本,否则“Sanity”报告重复类型.
列报presentation()(中文(简体) )
从网站内容登记册接通的视觉编辑(config/content.config.ts,参见 @gluhar/routes),这样 mainDocuments 财务报告和审定财务报表 locations 与站点路由器保持同步:
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制造器 重命名一个 并且它不会在现场制造任何东西 备选案文:
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.