Skip to content
This repository was archived by the owner on Dec 10, 2024. It is now read-only.

Commit 106c974

Browse files
feat: docs
1 parent 881e062 commit 106c974

40 files changed

+10499
-0
lines changed

.docs/.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
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
22+
.env
23+
.env.*
24+
!.env.example

.docs/.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shamefully-hoist=true

.docs/.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"references.preferredLocation": "peek"
3+
}

.docs/README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Nuxt 3 Minimal Starter
2+
3+
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
4+
5+
## Setup
6+
7+
Make sure to install the dependencies:
8+
9+
```bash
10+
# npm
11+
npm install
12+
13+
# pnpm
14+
pnpm install
15+
16+
# yarn
17+
yarn install
18+
19+
# bun
20+
bun install
21+
```
22+
23+
## Development Server
24+
25+
Start the development server on `http://localhost:3000`:
26+
27+
```bash
28+
# npm
29+
npm run dev
30+
31+
# pnpm
32+
pnpm run dev
33+
34+
# yarn
35+
yarn dev
36+
37+
# bun
38+
bun run dev
39+
```
40+
41+
## Production
42+
43+
Build the application for production:
44+
45+
```bash
46+
# npm
47+
npm run build
48+
49+
# pnpm
50+
pnpm run build
51+
52+
# yarn
53+
yarn build
54+
55+
# bun
56+
bun run build
57+
```
58+
59+
Locally preview production build:
60+
61+
```bash
62+
# npm
63+
npm run preview
64+
65+
# pnpm
66+
pnpm run preview
67+
68+
# yarn
69+
yarn preview
70+
71+
# bun
72+
bun run preview
73+
```
74+
75+
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

.docs/[...slug].vue

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<script setup lang="ts">
2+
import type { NavItem } from '@nuxt/content/dist/runtime/types'
3+
4+
const navigation = inject<Ref<NavItem[]>>('navigation')
5+
6+
const route = useRoute()
7+
const { navPageFromPath } = useContentHelpers()
8+
const { headerLinks } = useNavigation()
9+
10+
const links = computed(() => headerLinks.value.find(link => link.to === '/pergel')?.children ?? [])
11+
12+
const navigationLinks = computed(() => {
13+
const path = ['/pergel', route.params.slug?.[0]].filter(Boolean).join('/')
14+
15+
return mapContentNavigation(navPageFromPath(path, navigation!.value)?.children || [])
16+
})
17+
</script>
18+
19+
<template>
20+
<UContainer>
21+
<UPage>
22+
<template #left>
23+
<UAside :links="links">
24+
<UDivider type="dashed" class="mb-6" />
25+
26+
<UNavigationTree :links="navigationLinks" default-open :multiple="false" />
27+
</UAside>
28+
</template>
29+
30+
<NuxtPage />
31+
</UPage>
32+
</UContainer>
33+
</template>

.docs/app.config.ts

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
export default defineAppConfig({
2+
ui: {
3+
primary: 'yellow',
4+
gray: 'slate',
5+
avatar: {
6+
default: {
7+
icon: 'i-ph-image',
8+
},
9+
},
10+
button: {
11+
default: {
12+
loadingIcon: 'i-ph-spinner',
13+
},
14+
},
15+
input: {
16+
default: {
17+
loadingIcon: 'i-ph-spinner',
18+
},
19+
},
20+
select: {
21+
default: {
22+
loadingIcon: 'i-ph-spinner',
23+
trailingIcon: 'i-ph-caret-down',
24+
},
25+
},
26+
selectMenu: {
27+
default: {
28+
selectedIcon: 'i-ph-check',
29+
},
30+
},
31+
notification: {
32+
default: {
33+
closeButton: {
34+
icon: 'i-ph-x',
35+
},
36+
},
37+
},
38+
commandPalette: {
39+
default: {
40+
icon: 'i-ph-magnifying-glass-duotone',
41+
loadingIcon: 'i-ph-spinner',
42+
selectedIcon: 'i-ph-check',
43+
emptyState: {
44+
icon: 'i-ph-magnifying-glass-duotone',
45+
},
46+
closeButton: {
47+
icon: 'i-ph-x',
48+
},
49+
},
50+
},
51+
table: {
52+
default: {
53+
sortAscIcon: 'i-ph-sort-ascending',
54+
sortDescIcon: 'i-ph-sort-descending',
55+
sortButton: {
56+
icon: 'i-ph-list',
57+
},
58+
loadingState: {
59+
icon: 'i-ph-spinner',
60+
},
61+
emptyState: {
62+
icon: 'i-ph-database',
63+
},
64+
},
65+
},
66+
pagination: {
67+
default: {
68+
prevButton: {
69+
icon: 'i-ph-arrow-left',
70+
},
71+
nextButton: {
72+
icon: 'i-ph-arrow-right',
73+
},
74+
},
75+
},
76+
card: {
77+
rounded: 'rounded-xl',
78+
},
79+
tooltip: {
80+
background: '!bg-background',
81+
popper: {
82+
strategy: 'absolute',
83+
},
84+
},
85+
breadcrumb: {
86+
divider: {
87+
base: 'w-4 h-4',
88+
},
89+
default: {
90+
divider: 'i-ph-caret-right',
91+
},
92+
},
93+
// `@nuxt/ui-pro` specific
94+
variables: {
95+
dark: {
96+
background: 'var(--color-gray-950)',
97+
},
98+
},
99+
icons: {
100+
dark: 'i-ph-moon-duotone',
101+
light: 'i-ph-sun-duotone',
102+
search: 'i-ph-magnifying-glass-duotone',
103+
external: 'i-ph-arrow-up-right',
104+
chevron: 'i-ph-caret-down',
105+
hash: 'i-ph-hash-duotone',
106+
},
107+
header: {
108+
wrapper: 'lg:mb-0 lg:border-0',
109+
links: {
110+
trailingIcon: {
111+
base: 'w-4 h-4',
112+
},
113+
popover: {
114+
popper: {
115+
strategy: 'absolute',
116+
},
117+
ui: {
118+
width: 'w-[16rem]',
119+
},
120+
},
121+
},
122+
popover: {
123+
links: {
124+
active: 'dark:bg-gray-950/50',
125+
inactive: 'dark:hover:bg-gray-950/50',
126+
},
127+
},
128+
button: {
129+
icon: {
130+
open: 'i-ph-list',
131+
close: 'i-ph-x',
132+
},
133+
},
134+
},
135+
navigation: {
136+
accordion: {
137+
button: {
138+
trailingIcon: {
139+
base: 'w-4 h-4',
140+
},
141+
},
142+
},
143+
},
144+
page: {
145+
card: {
146+
to: 'dark:hover:bg-gray-900/50',
147+
},
148+
},
149+
docs: {
150+
search: {
151+
fileIcon: {
152+
name: 'i-ph-file-text-duotone',
153+
},
154+
},
155+
toc: {
156+
button: {
157+
trailingIcon: {
158+
base: 'w-4 h-4',
159+
},
160+
},
161+
},
162+
surround: {
163+
icon: {
164+
prev: 'i-ph-arrow-left',
165+
next: 'i-ph-arrow-right',
166+
},
167+
},
168+
},
169+
content: {
170+
collapsible: {
171+
button: {
172+
icon: {
173+
base: 'w-3 h-3',
174+
},
175+
},
176+
},
177+
prose: {
178+
code: {
179+
button: {
180+
icon: {
181+
copy: 'i-ph-copy-duotone',
182+
copied: 'i-ph-check-square-duotone',
183+
},
184+
},
185+
icon: {
186+
terminal: 'i-ph-terminal-window-duotone',
187+
},
188+
},
189+
},
190+
},
191+
},
192+
})

0 commit comments

Comments
 (0)