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 your project:

npx nuxi@latest module add 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:

npx nuxi@latest module add studio

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

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.3.4 (2022-12-06)

Bug Fixes

• support baseURL for app.config (f875826)

0.3.3 (2022-12-06)

Features

• app-config: add support for .studio files (#80) (8804f40)

0.3.2 (2022-12-05)

Features

• appConfig improvements (#78) (6e4a6da)

0.3.1 (2022-11-29)

Bug Fixes

• enable studio only in production (#76) (bc8234c)
• force nuxt-config-schema for now until part of core (5805047)

0.3.0 (2022-11-29)

⚠ BREAKING CHANGES

• expose app config (#74)

Features

• expose app config (#74) (4d0d200)

0.2.7 (2022-11-25)

Bug Fixes

• components: drop exposed field in meta (#71) (e2570fb)
• preview: prevent calling refreshNuxtData when preview mode is disabled (#73) (955e2a4)

0.2.6 (2022-11-21)

Features

• disable preview mode is query exists and its falsy (#68) (8611eea)
• preview: send events through message to studio (#65) (4c7d8d1)

Bug Fixes

• preview: change loading background in dark mode (#64) (6397d6b)

0.2.5 (2022-11-18)

Bug Fixes

• socket: add auth token (#67) (9962ae5)

0.2.4 (2022-11-18)

Bug Fixes

• preview: send token from params for sync (#66) (c985aa3)

0.2.3 (2022-11-16)

Features

• preview: loading overlay (#63) (084b5d7)

0.2.2 (2022-11-10)

Bug Fixes

• missing useRuntimeConfig import (dcf7d30)

0.2.1 (2022-11-10)

Bug Fixes

• add missing import (55364f5)

0.2.0 (2022-11-10)

⚠ BREAKING CHANGES

• Rename to /__studio and expose modules meta (#60)

Features

• Rename to /__studio and expose modules meta (#60) (fbb3147)

0.1.5 (2022-11-09)

Bug Fixes

• handle missing content in drafts (#58) (50f88d7)

0.1.4 (2022-11-03)

Features

• add /_studio_enabled.json route (2e24f0a), closes #56

0.1.3 (2022-11-03)

Features

• support STUDIO_API as env variable (14a333a)

0.1.2 (2022-11-03)

Bug Fixes

• lint (8ddc1f4)

0.1.1 (2022-11-03)

Bug Fixes

• add z-index and padding for preview bar (aaa2b72)