https://github.com/stonega/nuxt-magicui

https://github.com/stonega/nuxt-magicui

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/stonega/nuxt-magicui
• Owner: stonega
• Created: 2024-09-02T03:51:52.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-04T19:31:50.000Z (about 1 year ago)
• Last Synced: 2024-11-04T20:32:31.481Z (about 1 year ago)
• Language: TypeScript
• Size: 688 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![nuxt-ui-docs-social-card](https://github.com/nuxt-ui-pro/docs/assets/739984/f64e13d9-9ae0-4e03-bf7f-6be4c36cd9ba)

# Nuxt UI Pro - Docs template

[![Nuxt UI Pro](https://img.shields.io/badge/Made%20with-Nuxt%20UI%20Pro-00DC82?logo=nuxt.js&labelColor=020420)](https://ui.nuxt.com/pro)

[![Nuxt Studio](https://img.shields.io/badge/Open%20in%20Nuxt%20Studio-18181B?&logo=nuxt.js&logoColor=3BB5EC)](https://nuxt.studio/themes/docs)

- [Live demo](https://docs-template.nuxt.dev/)

- [Play on Stackblitz](https://stackblitz.com/github/nuxt-ui-pro/docs)

- [Documentation](https://ui.nuxt.com/pro/getting-started)

- [Clone on Nuxt Studio](https://nuxt.studio/themes/docs)

## Quick Start

```bash [Terminal]

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

```

## Setup

Make sure to install the dependencies:

```bash

# npm

npm install

# pnpm

pnpm install

# yarn

yarn install

# bun

bun install

```

## Development Server

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

```bash

# npm

npm run dev

# pnpm

pnpm run dev

# yarn

yarn dev

# bun

bun run dev

```

## Production

Build the application for production:

```bash

# npm

npm run build

# pnpm

pnpm run build

# yarn

yarn build

# bun

bun run build

```

Locally preview production build:

```bash

# npm

npm run preview

# pnpm

pnpm run preview

# yarn

yarn preview

# bun

bun run preview

```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

## Nuxt Studio integration

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

```bash

# 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`:

```ts

export default defineNuxtConfig({

  ...

  modules: [

    ...

    '@nuxthq/studio'

  ]

})

```

Read more on [Nuxt Studio docs](https://nuxt.studio/docs/get-started/setup).

## Renovate integration

Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.