63 lines
1.9 KiB
Markdown
Executable File
63 lines
1.9 KiB
Markdown
Executable File
# Nuxt Docs Template
|
|
|
|
[](https://ui.nuxt.com)
|
|
|
|
Use this template to build your own documentation with [Nuxt UI](https://ui.nuxt.com) quickly.
|
|
|
|
- [Live demo](https://docs-template.nuxt.dev/)
|
|
- [Documentation](https://ui.nuxt.com/docs/getting-started/installation)
|
|
|
|
<a href="https://docs-template.nuxt.dev/" target="_blank">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-dark.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
|
|
<img alt="Nuxt Docs Template" src="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
|
|
</picture>
|
|
</a>
|
|
|
|
## Quick Start
|
|
|
|
```bash [Terminal]
|
|
npm create nuxt@latest -- -t github:nuxt-ui-templates/docs
|
|
```
|
|
|
|
## Deploy your own
|
|
|
|
[](https://vercel.com/new/clone?repository-name=docs&repository-url=https%3A%2F%2Fgithub.com%2Fnuxt-ui-templates%2Fdocs&demo-image=https%3A%2F%2Fui.nuxt.com%2Fassets%2Ftemplates%2Fnuxt%2Fdocs-dark.png&demo-url=https%3A%2F%2Fdocs-template.nuxt.dev%2F&demo-title=Nuxt%20Docs%20Template&demo-description=A%20documentation%20template%20powered%20by%20Nuxt%20Content.)
|
|
|
|
## Setup
|
|
|
|
Make sure to install the dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
## Development Server
|
|
|
|
Start the development server on `http://localhost:3000`:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
## Production
|
|
|
|
Build the application for production:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
Locally preview production build:
|
|
|
|
```bash
|
|
pnpm preview
|
|
```
|
|
|
|
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
|
|
|
## Renovate integration
|
|
|
|
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.
|