Skip to content

Commit 7ebf41d

Browse files
committed
updated: vaah docs
1 parent 013cec8 commit 7ebf41d

File tree

970 files changed

+23196
-55964
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

970 files changed

+23196
-55964
lines changed

.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_size = 2
6+
indent_style = space
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Production license for @nuxt/ui-pro, get one at https://ui.nuxt.com/pro/purchase
2+
NUXT_UI_PRO_LICENSE=
3+
4+
# Public URL, used for OG Image when running nuxt generate
5+
NUXT_PUBLIC_SITE_URL=

.eslintignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
dist
22
node_modules
33
.output
4-
.nuxt
4+
.nuxt

.eslintrc.cjs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
module.exports = {
22
root: true,
3-
extends: '@nuxt/eslint-config',
3+
extends: [
4+
'@nuxt/eslint-config'
5+
],
46
rules: {
7+
// Global
8+
semi: ['error', 'never'],
9+
quotes: ['error', 'single'],
10+
'quote-props': ['error', 'as-needed'],
11+
// Vue
12+
'vue/multi-word-component-names': 0,
513
'vue/max-attributes-per-line': 'off',
6-
'vue/multi-word-component-names': 'off'
14+
'vue/no-v-html': 0
715
}
816
}

.gitignore

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
1-
node_modules
2-
*.iml
3-
.idea
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
44
.nuxt
5-
.vscode
6-
.DS_Store
7-
coverage
5+
.nitro
6+
.cache
87
dist
9-
sw.*
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
21+
# Local env files
1022
.env
11-
.output
23+
.env.*
24+
!.env.example
25+
26+
# VSC
27+
.history
28+
29+
.vercel

.npmrc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
shamefully-hoist=true
2-
strict-peer-dependencies=false

README.md

Lines changed: 90 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,125 @@
1-
# Docus Starter
1+
![nuxt-ui-pro-docs-template](https://github.com/nuxt-ui-pro/docs/assets/904724/67fc15a7-92f6-4566-95b9-fe099012473c)
22

3-
Starter template for [Docus](https://docus.dev).
3+
# Nuxt UI Pro - Docs template
44

5-
## Clone
5+
[![Nuxt UI Pro](https://img.shields.io/badge/Made%20with-Nuxt%20UI%20Pro-00DC82?logo=nuxt.js&labelColor=020420)](https://ui.nuxt.com/pro)
6+
[![Nuxt Studio](https://img.shields.io/badge/Open%20in%20Nuxt%20Studio-18181B?&logo=nuxt.js&logoColor=3BB5EC)](https://nuxt.studio/themes/docs)
67

7-
Clone the repository (using `nuxi`):
8+
- [Live demo](https://nuxt-ui-pro-template-docs.vercel.app/)
9+
- [Play on Stackblitz](https://stackblitz.com/github/nuxt-ui-pro/docs)
10+
- [Documentation](https://ui.nuxt.com/pro/guide)
11+
- [Clone on Nuxt Studio](https://nuxt.studio/themes/docs)
812

9-
```bash
10-
npx nuxi init -t themes/docus
13+
## Quick Start
14+
15+
```bash [Terminal]
16+
npx nuxi init -t github:nuxt-ui-pro/docs
1117
```
1218

1319
## Setup
1420

15-
Install dependencies:
21+
Make sure to install the dependencies:
1622

1723
```bash
24+
# npm
25+
npm install
26+
27+
# pnpm
28+
pnpm install
29+
30+
# yarn
1831
yarn install
32+
33+
# bun
34+
bun install
1935
```
2036

21-
## Development
37+
## Development Server
38+
39+
Start the development server on `http://localhost:3000`:
2240

2341
```bash
42+
# npm
43+
npm run dev
44+
45+
# pnpm
46+
pnpm run dev
47+
48+
# yarn
2449
yarn dev
25-
```
2650

27-
## Edge Side Rendering
51+
# bun
52+
bun run dev
53+
```
2854

29-
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
55+
## Production
3056

31-
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
57+
Build the application for production:
3258

3359
```bash
60+
# npm
61+
npm run build
62+
63+
# pnpm
64+
pnpm run build
65+
66+
# yarn
3467
yarn build
68+
69+
# bun
70+
bun run build
3571
```
3672

37-
## Static Generation
73+
Locally preview production build:
3874

39-
Use the `generate` command to build your application.
75+
```bash
76+
# npm
77+
npm run preview
4078

41-
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
79+
# pnpm
80+
pnpm run preview
4281

43-
```bash
44-
yarn generate
82+
# yarn
83+
yarn preview
84+
85+
# bun
86+
bun run preview
4587
```
4688

47-
## Preview build
89+
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
4890

49-
You might want to preview the result of your build locally, to do so, run the following command:
91+
## Nuxt Studio integration
92+
93+
Add `@nuxthq/studio` dependency to your package.json:
5094

5195
```bash
52-
yarn preview
96+
# npm
97+
npm install --save-dev @nuxthq/studio
98+
99+
# pnpm
100+
pnpm add -D @nuxthq/studio
101+
102+
# yarn
103+
yarn add -D @nuxthq/studio
104+
105+
# bun
106+
bun add -d @nuxthq/studio
107+
```
108+
109+
Add this module to your `nuxt.config.ts`:
110+
111+
```ts
112+
export default defineNuxtConfig({
113+
...
114+
modules: [
115+
...
116+
'@nuxthq/studio'
117+
]
118+
})
53119
```
54120

55-
---
121+
Read more on [Nuxt Studio docs](https://nuxt.studio/docs/projects/setup).
122+
123+
## Renovate integration
56124

57-
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
125+
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.

app.config.js

Lines changed: 0 additions & 47 deletions
This file was deleted.

app.config.ts

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
let credits = 'Copyright © '+new Date().getFullYear()
2+
export default defineAppConfig({
3+
ui: {
4+
primary: 'green',
5+
danger: 'red',
6+
gray: 'slate',
7+
footer: {
8+
bottom: {
9+
left: 'text-sm text-gray-500 dark:text-gray-400',
10+
wrapper: 'border-t border-gray-200 dark:border-gray-800'
11+
}
12+
}
13+
},
14+
seo: {
15+
siteName: 'WebReinvent Internal Docs',
16+
},
17+
header: {
18+
logo: {
19+
alt: 'WebReinvent Internal Docs',
20+
light: '/logos/light.svg',
21+
dark: '/logos/dark.svg'
22+
},
23+
search: false,
24+
colorMode: true,
25+
links: [{
26+
icon: 'i-simple-icons-github',
27+
to: 'https://github.com/webreinvent/webreinvent-docs',
28+
target: '_blank',
29+
'aria-label': 'Docs template on GitHub'
30+
}]
31+
},
32+
footer: {
33+
credits: credits,
34+
colorMode: false,
35+
links: [{
36+
icon: 'i-simple-icons-github',
37+
to: 'https://github.com/webreinvent',
38+
target: '_blank',
39+
'aria-label': 'WebReinvent on GitHub'
40+
}]
41+
},
42+
toc: {
43+
title: 'Table of Contents',
44+
bottom: {
45+
title: 'Community',
46+
edit: 'https://github.com/webreinvent/webreinvent-docs/edit/develop/content',
47+
links: [{
48+
icon: 'i-heroicons-book-open',
49+
label: 'Nuxt UI Pro docs',
50+
to: 'https://ui.nuxt.com/pro/guide',
51+
target: '_blank',
52+
}]
53+
}
54+
}
55+
})

app.vue

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<script setup lang="ts">
2+
import type { ParsedContent } from '@nuxt/content/dist/runtime/types'
3+
import { useRootStore } from '@/stores/root'
4+
5+
const { seo } = useAppConfig()
6+
7+
const { data: navigation } = await useAsyncData('navigation', () => fetchContentNavigation())
8+
const { data: files } = useLazyFetch<ParsedContent[]>('/api/search.json', {
9+
default: () => [],
10+
server: false
11+
})
12+
13+
useHead({
14+
meta: [
15+
{ name: 'viewport', content: 'width=device-width, initial-scale=1' }
16+
],
17+
link: [
18+
{ rel: 'icon', href: '/favicon.ico' }
19+
],
20+
htmlAttrs: {
21+
lang: 'en'
22+
}
23+
})
24+
25+
useSeoMeta({
26+
ogSiteName: seo?.siteName,
27+
twitterCard: 'summary_large_image'
28+
})
29+
30+
const rootStore = useRootStore()
31+
32+
provide('navigation', navigation)
33+
</script>
34+
35+
<template>
36+
<div>
37+
<Header />
38+
39+
<UMain>
40+
<NuxtLayout>
41+
<NuxtPage />
42+
</NuxtLayout>
43+
</UMain>
44+
45+
<Footer />
46+
47+
<ClientOnly>
48+
<LazyUDocsSearch :files="files" :navigation="navigation" />
49+
</ClientOnly>
50+
51+
<UNotifications />
52+
53+
</div>
54+
</template>

0 commit comments

Comments
 (0)