Nuxt Studio

设置 Nuxt Studio

Studio 是用于编辑 Nuxt Content 网站的直观 CMS 界面。编辑你的 Markdown、YAML 和 JSON 文件,并将更改发布到 GitHub。

Studio 是一个直观的 CMS 界面,用于编辑你的 Nuxt Content 网站。

它利用 Nuxt Content 内置的 Preview API,为内容文件提供最佳编辑体验。编辑者可以通过用户友好的界面编辑他们的 MarkdownYAMLJSON 文件。

开发者可以自定义编辑体验并为编辑者提供工具,使编辑者能够专注于内容,无需任何技术专长。

认证

Studio 管理后台位于 nuxt.studio。你可以通过 GitHub 或 Google 登录。两种方式会赋予相同的编辑权限,但由于 Studio 与 GitHub 同步,仓库导入必须由 GitHub 用户操作。

Google 认证适用于非技术用户。Google 用户必须加入已有项目的团队才能进行编辑。

连接你的 Nuxt Content 仓库

登录管理后台后,你可以直接从界面导入你的 Nuxt Content 仓库。

有两种选择,你可以导入一个已有的仓库,或使用我们的 模板

唯一的要求是你的仓库必须托管在 GitHub 上。通过界面连接我们的 GitHub 应用,然后即可将 GitHub 仓库链接到你的 Studio 项目中。

项目创建成功后,你就可以使用 Studio 的编辑器开始编辑文件,并发布你的更改。

启用完整编辑体验

要解锁 Studio 的全部功能,请确保你的项目 URL 在部署部分正确配置。

这将启用所有 Studio 功能,包括:

  • 网站实时预览: 在编辑时立即在网站上看到更改效果。
  • 动态表单生成: 根据你的 Nuxt Content 集合自动生成编辑表单。
  • 增强的 Markdown 编辑器: 提供更好的编辑体验,包括列出和集成你已暴露的 Vue 组件
  • 自动应用配置: 根据你定义的 schema 生成 应用配置
我们提供了 GitHub Pages 部署方案,使用它可以帮你处理所有要求。如果你想使用自己选择的部署平台,请参照以下简单指南。

要在 Studio 中设置你的 URL,只需在 nuxt.config.ts 文件的内容配置中设置 Preview API

nuxt.config.ts
export default defineNuxtConfig({
  content: {
    preview: {
      api: 'https://api.nuxt.studio'
    }
  }
})

部署完成后,可通过访问网站的 /__preview.json 页面确认 Preview API 是否已生效。该元数据页面由 Content 模块自动生成,且必须可访问,才能在 Studio 的自托管部分连接你的 URL。

故障排查

如果已生成 __preview.json 文件,但在自托管部分设置 URL 时遇到 Forbidden error: invalid property check 错误,请按以下步骤操作:

确保 __preview.json 文件中的 gitInfo 字段已设置且准确无误

https://your-website.com/__preview.json
"gitInfo": {
  "name": "content",
  "owner": "nuxt",
  "url": "https://github.com/nuxt/content"
},
此信息通常会自动填充。我们支持大多数流行的提供商(NuxtHub、Vercel、Netlify 等),但如果你使用的是不支持或自定义的提供商,可能无法正确获取。

在你的 nuxt.config.ts 中覆盖 gitInfo

nuxt.config.ts
export default defineNuxtConfig({
  content: {
    preview: {
      api: 'https://api.nuxt.studio',
      gitInfo: {
        name: '你的仓库名',
        owner: '你的仓库拥有者/组织',
        url: '你的 GitHub 仓库 URL'
      }
    }
  }
})

确保 __preview.json 中字段设置正确

Forbidden error 应该被修复,你也应当能在 Nuxt Studio 设置你的 URL。如果问题仍未解决,请通过我们的 Discord 服务器 联系我们。