Nuxt Studio Theme Starter
Create a compatible Nuxt Studio theme with this GitHub template.
Setup
Make sure to install the dependencies:
pnpm install
Working on your theme
Your theme is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.
The .starters/default/
directory should help you on trying your theme during development.
Running pnpm dev
will prepare and boot .starters/default/
directory, which imports your theme itself.
Distributing your theme
Your Nuxt theme is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.
To do so, you only have to check if files
in package.json
are valid, then run:
npm publish --access public
Once done, your users will only have to run:
npm install --save your-theme
Then add the dependency to their extends
in nuxt.config.ts
:
export default defineNuxtConfig({
extends: 'your-theme'
})
Development Server
Start the development server on http://localhost:3000
pnpm dev
Production
Build the application for production:
pnpm build
Or statically generate it with:
pnpm generate
Locally preview production build:
pnpm preview
Checkout the deployment documentation for more information.