Skip to content

Create your documentation in seconds with this template

Notifications You must be signed in to change notification settings

whitemouse87/docs

Repository files navigation

nuxt-ui-docs-social-card

Nuxt UI Pro - Docs template

Nuxt UI Pro Nuxt Studio

Deploy to NuxtHub

Quick Start

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

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

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

Studio is an intuitive CMS interface to edit your Nuxt Content websites.

It take advantage of the Preview API included in Nuxt Content to propose the best editing experience for your content files. Editors can benefit from a user-friendly interface to edit their Markdown, YAML or JSON files.

You can import your project on the platform without any extra setup.

However to enable the live preview on the platform, you just need to activate studio in the content configuration of your nuxt.config.ts file.

export default defineNuxtConfig({
  content: {
    studio: {
      enabled: true
    }
  }
})

Read more on Nuxt Studio docs.

Renovate integration

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

About

Create your documentation in seconds with this template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published