Nuxt UI Pro - Docs template

• Live demo
• Play on Stackblitz
• Documentation
• Clone on Nuxt Studio

Quick Start

npx nuxi init -t github:nuxt-ui-pro/docs

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Vaahstore API Bundling

Install the Package: If you haven't already installed the @redocly/cli, you can do so with the following command:

# npm
npm install --save-dev @redocly/cli

# pnpm
pnpm add -D @redocly/cli

# yarn
yarn add -D @redocly/cli

# bun
bun add -d @redocly/cli

Run the Bundling Script: Once you have the script set up in your package.json, you can run it using your package manager:

# npm
npm run vaahstore:api

# pnpm
pnpm run vaahstore:api

# yarn
yarn vaahstore:api

# bun
bun run vaahstore:api

Output: This command will take the VaahStore OpenAPI specification files located at public/vaahstore-api/vaahstore.yaml and bundle it into a single file named vaahstore-apis.yaml, which will be output to the public directory.

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview

Check out the deployment documentation for more information.

Nuxt Studio integration

Add @nuxthq/studio dependency to your package.json:

# npm
npm install --save-dev @nuxthq/studio

# pnpm
pnpm add -D @nuxthq/studio

# yarn
yarn add -D @nuxthq/studio

# bun
bun add -d @nuxthq/studio

Add this module to your nuxt.config.ts:

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

Read more on Nuxt Studio docs.

Renovate integration

Install Renovate GitHub app on your repository and you are good to go.