Tino Koch 562f8bb295 chore: 1061 fix eslint errors in docs (#1063) 23 시간 전
..
app 562f8bb295 chore: 1061 fix eslint errors in docs (#1063) 23 시간 전
content 5fc0c70f0d docs: fixed javascript highlighting 1 일 전
public 776c30dec5 chore: og docs (#1057) 5 일 전
.editorconfig 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
.env.example 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
.gitignore 575ed04911 chore: 1059 fix typecheck errors in docs (#1060) 3 일 전
.npmrc 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
README.md 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
content.config.ts 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
eslint.config.mjs 562f8bb295 chore: 1061 fix eslint errors in docs (#1063) 23 시간 전
nuxt.config.ts 562f8bb295 chore: 1061 fix eslint errors in docs (#1063) 23 시간 전
nuxt.schema.ts 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
package.json 562f8bb295 chore: 1061 fix eslint errors in docs (#1063) 23 시간 전
renovate.json 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전
tsconfig.json 839f6d03af chore: 1031 migrate docs to nuxt UI docs template (#1049) 5 일 전

README.md

Nuxt Docs Template

Nuxt UI Pro Deploy to NuxtHub

This template lets you build a documentation with Nuxt UI Pro quickly.

<source media="(prefers-color-scheme: dark)" srcset="https://assets.hub.nuxt.com/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwczovL2RvY3MtdGVtcGxhdGUubnV4dC5kZXYiLCJpYXQiOjE3Mzk0NjM0MTd9.ltVAqPgKG38O01X1zl6MXfrJc55nf9OewXNFjpZ_2JY.jpg?theme=dark">
<source media="(prefers-color-scheme: light)" srcset="https://assets.hub.nuxt.com/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwczovL2RvY3MtdGVtcGxhdGUubnV4dC5kZXYiLCJpYXQiOjE3Mzk0NjM0MTd9.ltVAqPgKG38O01X1zl6MXfrJc55nf9OewXNFjpZ_2JY.jpg?theme=light">
<img alt="Nuxt Docs Template" src="https://assets.hub.nuxt.com/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwczovL2RvY3MtdGVtcGxhdGUubnV4dC5kZXYiLCJpYXQiOjE3Mzk0NjM0MTd9.ltVAqPgKG38O01X1zl6MXfrJc55nf9OewXNFjpZ_2JY.jpg">

Quick Start

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

Setup

Make sure to install the dependencies:

pnpm install

Development Server

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

pnpm dev

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm 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: {
    preview: {
      api: 'https://api.nuxt.studio'
    }
  }
})

Read more on Nuxt Studio docs.

Renovate integration

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