Back to Details

nuxt-studio

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Nuxt Studio

Nuxt Studio

Self-hosted, open-source CMS module for editing Nuxt Content websites in production.
一款自托管的开源CMS模块，用于在生产环境中编辑Nuxt Content网站。

When to Use

适用场景

Working with:
  • Installing and configuring 
    nuxt-studio
    module
  • Authentication providers (GitHub, GitLab, Google OAuth, SSO, custom)
  • Git provider setup (GitHub, GitLab, branch config)
  • Visual content editing (MDC components, YAML/JSON forms, frontmatter)
  • Media management (public dir, NuxtHub blob, S3, R2)
  • Publishing flow (draft layer, conflict detection, CI/CD rebuild)
  • AI-powered content assistance (Vercel AI Gateway)
For content collections/queries: use 
nuxt-content
skill For NuxtHub storage/database: use 
nuxthub
skill For Nuxt basics: use 
nuxt
skill
适用于以下场景：
  • 安装和配置
    nuxt-studio
    模块
  • 身份验证提供商（GitHub、GitLab、Google OAuth、SSO、自定义）
  • Git提供商设置（GitHub、GitLab、分支配置）
  • 可视化内容编辑（MDC组件、YAML/JSON表单、前置元数据）
  • 媒体管理（public目录、NuxtHub对象存储、S3、R2）
  • 发布流程（草稿层、冲突检测、CI/CD重新构建）
  • AI驱动的内容辅助（Vercel AI Gateway）
若涉及内容集合/查询： 使用
nuxt-content
技能 若涉及NuxtHub存储/数据库： 使用
nuxthub
技能 若涉及Nuxt基础操作： 使用
nuxt
技能

Available Guidance

可用指南

Read specific files based on current work:
  • references/configuration.md - Module setup, auth providers, Git providers, environment variables
  • references/live-editing.md - Visual editor, media management, MDC components, AI features
  • references/deployment.md - SSR requirements, Git publishing, branch strategies, CI/CD
根据当前工作内容阅读特定文件：
  • references/configuration.md - 模块设置、身份验证提供商、Git提供商、环境变量
  • references/live-editing.md - 可视化编辑器、媒体管理、MDC组件、AI功能
  • references/deployment.md - SSR要求、Git发布、分支策略、CI/CD

Loading Files

文件加载建议

Consider loading these reference files based on your task:
  • references/configuration.md - if installing, configuring auth/git providers, or setting env vars
  • references/live-editing.md - if working with content editor, media, components, or AI features
  • references/deployment.md - if deploying, configuring branches, or troubleshooting publish flow
DO NOT load all files at once. Load only what's relevant to your current task.
请根据你的任务加载相关参考文件：
  • references/configuration.md - 若你正在安装、配置身份验证/Git提供商，或设置环境变量
  • references/live-editing.md - 若你正在使用内容编辑器、媒体管理、组件或AI功能
  • references/deployment.md - 若你正在部署、配置分支，或排查发布流程问题
请勿一次性加载所有文件。 仅加载与当前任务相关的文件。

Key Concepts

核心概念

ConceptPurpose
Auth providersControl who can access Studio (GitHub, GitLab, Google, SSO)
Git providersHandle publishing commits to your repository
Draft layerIndexedDB-backed local storage for unpublished changes
Media managerUpload/browse files in 
/public
or external blob storage
Visual editorTipTap-based WYSIWYG with MDC component support
PublishingCommits drafts to Git, triggers CI/CD rebuild
概念用途
身份验证提供商控制可访问Studio的用户（GitHub、GitLab、Google、SSO）
Git提供商处理将提交发布到你的代码仓库的操作
草稿层基于IndexedDB的本地存储，用于保存未发布的变更
媒体管理器在
/public
目录或外部对象存储中上传/浏览文件
可视化编辑器基于TipTap的WYSIWYG编辑器，支持MDC组件
发布功能将草稿提交到Git仓库，触发CI/CD重新构建

Quick Start

快速开始

bash
npx nuxt module add nuxt-studio
ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/content', 'nuxt-studio'],
  studio: {
    repository: {
      provider: 'github',
      owner: 'your-username',
      repo: 'your-repo',
      branch: 'main',
    },
  },
})
bash
undefined
bash
npx nuxt module add nuxt-studio
ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/content', 'nuxt-studio'],
  studio: {
    repository: {
      provider: 'github',
      owner: 'your-username',
      repo: 'your-repo',
      branch: 'main',
    },
  },
})
bash
undefined

.env

.env

STUDIO_GITHUB_CLIENT_ID=<client_id> STUDIO_GITHUB_CLIENT_SECRET=<client_secret>

Access Studio at `https://your-site.com/_studio` (default route).
STUDIO_GITHUB_CLIENT_ID=<client_id> STUDIO_GITHUB_CLIENT_SECRET=<client_secret>

通过默认路由`https://your-site.com/_studio`访问Studio。

Official Documentation

官方文档

Token Efficiency

Token使用效率

Main skill: ~300 tokens. Each sub-file: ~800-1200 tokens. Only load files relevant to current task.
主技能约占300 Token。每个子文件约占800-1200 Token。仅加载与当前任务相关的文件。