Skip to content

Commit c6ae04f

Browse files
committed
feat: change readme
1 parent 3c14c6e commit c6ae04f

1 file changed

Lines changed: 1 addition & 62 deletions

File tree

README.md

Lines changed: 1 addition & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1 @@
1-
# Nuxt Docs Template
2-
3-
[![Nuxt UI](https://img.shields.io/badge/Made%20with-Nuxt%20UI-00DC82?logo=nuxt&labelColor=020420)](https://ui.nuxt.com)
4-
5-
Use this template to build your own documentation with [Nuxt UI](https://ui.nuxt.com) quickly.
6-
7-
- [Live demo](https://docs-template.nuxt.dev/)
8-
- [Documentation](https://ui.nuxt.com/docs/getting-started/installation)
9-
10-
<a href="https://docs-template.nuxt.dev/" target="_blank">
11-
<picture>
12-
<source media="(prefers-color-scheme: dark)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-dark.png">
13-
<source media="(prefers-color-scheme: light)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
14-
<img alt="Nuxt Docs Template" src="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
15-
</picture>
16-
</a>
17-
18-
## Quick Start
19-
20-
```bash [Terminal]
21-
npm create nuxt@latest -- -t github:nuxt-ui-templates/docs
22-
```
23-
24-
## Deploy your own
25-
26-
[![Deploy with Vercel](https://vercel.com/button)](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.)
27-
28-
## Setup
29-
30-
Make sure to install the dependencies:
31-
32-
```bash
33-
pnpm install
34-
```
35-
36-
## Development Server
37-
38-
Start the development server on `http://localhost:3000`:
39-
40-
```bash
41-
pnpm dev
42-
```
43-
44-
## Production
45-
46-
Build the application for production:
47-
48-
```bash
49-
pnpm build
50-
```
51-
52-
Locally preview production build:
53-
54-
```bash
55-
pnpm preview
56-
```
57-
58-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
59-
60-
## Renovate integration
61-
62-
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.
1+
# Vercube docs

0 commit comments

Comments
 (0)