@nuxthq/studio

Nuxt Studio Module

Official module of Nuxt Studio.

Edit your websites made with Nuxt Content, in production on any device.

📖  Official Documentation

Features

• 🚀  Production live preview
• ⌨️  Edit your content
• ⚙️  Update your configs

Installation

Install the dependency to you project:

# NPM
npm install --save-dev @nuxthq/studio
# Yarn
yarn add --dev @nuxthq/studio
# pnpm
pnpm add --save-dev @nuxthq/studio

Then, register the module in your nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    '@nuxthq/studio'
  ]
})

Configuration

Check out our setup requirements.

By default the Studio API is https://api.nuxt.studio. If you want to customise it, you can set the STUDIO_API environement variable.

# .env
STUDIO_API=http://localhost:{PORT}

Nightly Builds

You can install the latest nightly build of the Studio module by running:

npm i @nuxthq/studio@nightly

Development

• Run pnpm i to install dependencies.
• Run pnpm dev:prepare to prepare the module in development mode.
• Run pnpm dev to start the dev server using playground/ as the project.
• Visit http://localhost:3000/

License

MIT License

Copyright (c) NuxtLabs