Skip to content

Commit 145868c

Browse files
HugoRCDHugoRCD
committed
up
1 parent 2390f8e commit 145868c

File tree

3 files changed

+199
-33
lines changed

3 files changed

+199
-33
lines changed

‎content/1.getting-started/1.index.md‎

Lines changed: 61 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,79 @@ This template is a ready-to-use documentation template made with [Nuxt UI Pro](h
88

99
There are already many websites based on this template:
1010

11-
- [Nuxt](https://nuxt.com) - The Nuxt website
12-
- [Nuxt UI](https://ui.nuxt.com) - The documentation of `@nuxt/ui` and `@nuxt/ui-pro`
13-
- [Nuxt Image](https://image.nuxt.com) - The documentation of `@nuxt/image`
14-
- [Nuxt Content](https://content.nuxt.com) - The documentation of `@nuxt/content`
15-
- [Nuxt Devtools](https://devtools.nuxt.com) - The documentation of `@nuxt/devtools`
16-
- [Nuxt Studio](https://content.nuxt.com/docs/studio) - The pro version of Nuxt Content
11+
::card-group
1712

18-
## Features
13+
::card
14+
---
15+
title: Nuxt
16+
icon: i-simple-icons-nuxtdotjs
17+
to: https://nuxt.com
18+
target: _blank
19+
---
20+
The Nuxt website
21+
::
1922

20-
- Powered by [Nuxt 3](https://nuxt.com)
21-
- Built with [Nuxt UI](https://ui.nuxt.com) and [Nuxt UI Pro](https://ui.nuxt.com/pro)
22-
- Write content with [MDC syntax](https://content.nuxt.com/usage/markdown) thanks to [Nuxt Content](https://content.nuxt.com)
23-
- Compatible with [Nuxt Studio](https://content.nuxt.com/docs/studio)
24-
- Auto-generated sidebar navigation
25-
- Full-Text Search out of the box
26-
- Beautiful Typography styles
27-
- Dark mode support
28-
- And more...
23+
::card
24+
---
25+
title: Nuxt UI
26+
icon: i-simple-icons-nuxtdotjs
27+
to: https://ui3.nuxt.dev
28+
target: _blank
29+
---
30+
The documentation of `@nuxt/ui` and `@nuxt/ui-pro`
31+
::
2932

30-
## Play online
33+
::card
34+
---
35+
title: Nuxt Image
36+
icon: i-simple-icons-nuxtdotjs
37+
to: https://image.nuxt.com
38+
target: _blank
39+
---
40+
The documentation of `@nuxt/image`
41+
::
3142

32-
You can start playing with this template in your browser using our online sandboxes:
43+
::card
44+
---
45+
title: Nuxt Content
46+
icon: i-simple-icons-nuxtdotjs
47+
to: https://content.nuxt.com
48+
target: _blank
49+
---
50+
The documentation of `@nuxt/content`
51+
::
3352

34-
::u-button
53+
::card
3554
---
36-
class: mr-4
37-
icon: i-simple-icons-stackblitz
38-
label: Play on StackBlitz
55+
title: Nuxt Devtools
56+
icon: i-simple-icons-nuxtdotjs
57+
to: https://devtools.nuxt.com
3958
target: _blank
40-
to: https://stackblitz.com/github/nuxt-ui-pro/docs/
4159
---
60+
The documentation of `@nuxt/devtools`
4261
::
4362

44-
::u-button
63+
::card
4564
---
46-
class: mt-2 sm:mt-0
47-
icon: i-simple-icons-codesandbox
48-
label: Play on CodeSandbox
65+
title: Nuxt Hub
66+
icon: i-simple-icons-nuxtdotjs
67+
to: https://hub.nuxt.com
4968
target: _blank
50-
to: https://codesandbox.io/s/github/nuxt-ui-pro/docs/
5169
---
70+
The best place to manage your projects, environments and variables.
71+
::
72+
5273
::
5374

54-
Or open [Nuxt UI playground](https://ui.nuxt.com/playground).
75+
## Features
76+
77+
- Powered by [Nuxt 3](https://nuxt.com)
78+
- Built with [Nuxt UI](https://ui.nuxt.com) and [Nuxt UI Pro](https://ui.nuxt.com/pro)
79+
- Write content with [MDC syntax](https://content.nuxt.com/usage/markdown) thanks to [Nuxt Content](https://content.nuxt.com)
80+
- Compatible with [Nuxt Studio](https://content.nuxt.com/docs/studio)
81+
- Auto-generated sidebar navigation
82+
- Full-Text Search out of the box
83+
- Beautiful Typography styles
84+
- Dark mode support
85+
- And more...
86+

‎content/2.essentials/3.prose-components.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,137 @@ This action cannot be undone.
135135
```
136136

137137
::
138+
139+
### Card
140+
141+
Use markdown in the default slot of the `card` component to highlight your content.
142+
143+
Use the `title`, `icon` and `color` props to customize it. You can also pass any property from the [`<NuxtLink>`](https://nuxt.com/docs/api/components/nuxt-link).
144+
145+
::code-preview{class="[&>div]:*:my-0 [&>div]:*:w-full"}
146+
147+
::card
148+
---
149+
title: Dashboard
150+
icon: i-simple-icons-github
151+
to: https://github.com/nuxt-ui-pro/dashboard
152+
target: _blank
153+
---
154+
A dashboard with multi-column layout.
155+
::
156+
157+
#code
158+
159+
```mdc
160+
::card
161+
---
162+
title: Dashboard
163+
icon: i-simple-icons-github
164+
to: https://github.com/nuxt-ui-pro/dashboard
165+
target: _blank
166+
---
167+
A dashboard with multi-column layout.
168+
::
169+
```
170+
171+
::
172+
173+
### CardGroup
174+
175+
Wrap your `card` components with the `card-group` component to group them together in a grid layout.
176+
177+
::code-preview
178+
179+
:::card-group{class="w-full"}
180+
181+
::card
182+
---
183+
title: Dashboard
184+
icon: i-simple-icons-github
185+
to: https://github.com/nuxt-ui-pro/dashboard
186+
target: _blank
187+
---
188+
A dashboard with multi-column layout.
189+
::
190+
191+
::card
192+
---
193+
title: SaaS
194+
icon: i-simple-icons-github
195+
to: https://github.com/nuxt-ui-pro/saas
196+
target: _blank
197+
---
198+
A template with landing, pricing, docs and blog.
199+
::
200+
201+
::card
202+
---
203+
title: Docs
204+
icon: i-simple-icons-github
205+
to: https://github.com/nuxt-ui-pro/docs
206+
target: _blank
207+
---
208+
A documentation with `@nuxt/content`.
209+
::
210+
211+
::card
212+
---
213+
title: Landing
214+
icon: i-simple-icons-github
215+
to: https://github.com/nuxt-ui-pro/landing
216+
target: _blank
217+
---
218+
A landing page you can use as starting point.
219+
::
220+
221+
:::
222+
223+
#code
224+
225+
```mdc
226+
::card-group
227+
228+
::card
229+
---
230+
title: Dashboard
231+
icon: i-simple-icons-github
232+
to: https://github.com/nuxt-ui-pro/dashboard
233+
target: _blank
234+
---
235+
A dashboard with multi-column layout.
236+
::
237+
238+
::card
239+
---
240+
title: SaaS
241+
icon: i-simple-icons-github
242+
to: https://github.com/nuxt-ui-pro/saas
243+
target: _blank
244+
---
245+
A template with landing, pricing, docs and blog.
246+
::
247+
248+
::card
249+
---
250+
title: Docs
251+
icon: i-simple-icons-github
252+
to: https://github.com/nuxt-ui-pro/docs
253+
target: _blank
254+
---
255+
A documentation with `@nuxt/content`.
256+
::
257+
258+
::card
259+
---
260+
title: Landing
261+
icon: i-simple-icons-github
262+
to: https://github.com/nuxt-ui-pro/landing
263+
target: _blank
264+
---
265+
A landing page you can use as starting point.
266+
::
267+
268+
::
269+
```
270+
271+
::

‎content/2.essentials/4.images-embeds.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ If [`@nuxt/image`](https://image.nuxt.com/get-started/installation) is installed
4141
To get more customizability with images, you can also use embeds to add images
4242

4343
::code-preview
44-
<img src="https://nuxt.com/new-social.jpg" alt="Nuxt Social Image" height="150">
44+
:img{src="https://nuxt.com/new-social.jpg" alt="Nuxt Social Image" height="150"}
4545

4646
#code
4747

4848
```mdc
49-
<img src="https://nuxt.com/new-social.jpg" alt="Nuxt Social Image" height="150">
49+
:img{src="https://nuxt.com/new-social.jpg" alt="Nuxt Social Image" height="150"}
5050
```
5151

5252
::
@@ -56,12 +56,12 @@ To get more customizability with images, you can also use embeds to add images
5656
You can also use embeds to add videos, iframes, etc.
5757

5858
::code-preview{class="[&>div]:*:w-full"}
59-
<iframe width="100%" height="100%" src="https://www.youtube-nocookie.com/embed/_eQxomah-nA?si=pDSzchUBDKb2NQu7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen style="aspect-ratio: 16/9;" class="rounded-[calc(var(--ui-radius)*1.5)]"></iframe>
59+
:iframe{src="https://www.youtube-nocookie.com/embed/_eQxomah-nA?si=pDSzchUBDKb2NQu7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen style="aspect-ratio: 16/9;"}
6060

6161
#code
6262

6363
```mdc
64-
<iframe width="100%" height="100%" src="https://www.youtube-nocookie.com/embed/_eQxomah-nA?si=pDSzchUBDKb2NQu7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen style="aspect-ratio: 16/9;" class="rounded-[calc(var(--ui-radius)*1.5)]"></iframe>
64+
:iframe{src="https://www.youtube-nocookie.com/embed/_eQxomah-nA?si=pDSzchUBDKb2NQu7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen style="aspect-ratio: 16/9;"}
6565
```
6666

6767
::

0 commit comments

Comments
 (0)