Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxt-ui-pro/docs
A documentation template made with Nuxt UI Pro.
https://github.com/nuxt-ui-pro/docs
docs-generator nuxt nuxt-template nuxt-ui nuxt-ui-pro vue
Last synced: 19 days ago
JSON representation
A documentation template made with Nuxt UI Pro.
- Host: GitHub
- URL: https://github.com/nuxt-ui-pro/docs
- Owner: nuxt-ui-pro
- Created: 2023-10-10T13:30:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T07:00:53.000Z (22 days ago)
- Last Synced: 2024-12-03T08:18:14.044Z (22 days ago)
- Topics: docs-generator, nuxt, nuxt-template, nuxt-ui, nuxt-ui-pro, vue
- Language: TypeScript
- Homepage: https://docs-template.nuxt.dev
- Size: 1.9 MB
- Stars: 157
- Watchers: 3
- Forks: 44
- Open Issues: 6
-
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/templates/docs)[![Deploy to NuxtHub](https://hub.nuxt.com/button.svg)](https://hub.nuxt.com/new?repo=nuxt-ui-pro/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.