Get Started

Create my first project

First steps on Studio.

No projects found page

As the Pro version of Nuxt Content, Nuxt Studio has been optimized for Nuxt content based website.

If you're using the Content module then your project is compatible by default and can be edited with Studio without any additional configuration.

Even if Studio is optimized for Nuxt Content projects, the only real requirement is to have a content folder in your project with Markdown files in it. This is enough to setup a project on Studio and to start editing and publishing your files with the platform.

Authentication

There are two different authentication methods. You can either login with GitHub or with Google. Both methods give you the same edition rights but since Studio is synchronized with GitHub, some features are specific to GitHub users, especially project creation (synchronized with a GitHub repository).

Since a Google user can not create a project he has to join a team with existing projects to edit them.

Create your project

Once you are logged in Studio, you have the possibility to create a project from the interface.

Two options are available, you can either start from an existing repository or use one of our templates.

The only requirement at that point is to connect to our GitHub app, you'll be then able to link a GitHub repository to your project.

Once the project is created, you can start editing your files with the Studio editor and publish your changes.

Enable the live preview

Once created, your project URL must be set to enjoy all Studio features, especially the live preview.

You can deploy your project yourself or use our GitHub Pages deployment.

If you are using our GitHub Pages deployment, we will handle all the requirements for you. However, if you have a self-hosted project, please follow the guidelines below.

To enable the live preview, you need to add our Studio Module to your project. You can do this by cloning your repository and adding the module from an external IDE.

Open a terminal within your repository folder and execute the following command:

npm i -D @nuxthq/studio

Once installed, add the module to your nuxt.config.ts file:

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