Skip to content

Commit 2dedfd2

Browse files
committed
up
1 parent 8e27415 commit 2dedfd2

File tree

1 file changed

+116
-24
lines changed

1 file changed

+116
-24
lines changed

content/2.essentials/1.markdown-syntax.md

Lines changed: 116 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Text, title, and styling in standard markdown.
55

66
## Titles
77

8-
Best used for page titles, headers, and sidebars.
9-
108
::code-preview{class="[&>div]:*:my-0"}
119

1210
## Titles
@@ -21,8 +19,6 @@ Best used for page titles, headers, and sidebars.
2119

2220
### Subtitles
2321

24-
Best used for page titles, headers, and sidebars.
25-
2622
::code-preview{class="[&>div]:*:my-0"}
2723

2824
### Subtitles
@@ -57,70 +53,166 @@ You can also combine them:
5753
| Bold Strike | `~~**bold**~~` | ~~**Bold**~~ |
5854
| Italic Strike | `~~*italic*~~` | ~~*Italic*~~ |
5955

60-
## Blockquotes
56+
You need to use HTML to write superscript and subscript text. Add `sup` or `sub` around your text to create superscript or subscript.
6157

62-
### Singleline
58+
| Style | How to use | Result |
59+
|-------------|--------------------------|------------------------|
60+
| Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
61+
| Subscript | `<sub>subscript</sub>` | <sub>subscript</sub> |
6362

64-
To create a blockquote, add a `>` in front of a paragraph.
63+
## Links
64+
65+
To create a link, wrap the link text in brackets `[]()`.
6566

6667
::code-preview{class="[&>div]:*:my-0"}
6768

68-
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
69+
[Nuxt UI Pro](https://ui3.nuxt.dev/getting-started/installation/pro/nuxt)
6970

7071
#code
7172

7273
```mdc
73-
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
74+
[Nuxt UI Pro](https://ui3.nuxt.dev/getting-started/installation/pro/nuxt)
7475
```
7576

7677
::
7778

78-
### Multiline
79+
### Links to other pages
80+
81+
Links to other pages of your documentation needs to be root-relative. For example, if you have a page called `getting-started/installation`, the link to that page should be `[Installation](/getting-started/installation)`.
7982

8083
::code-preview{class="[&>div]:*:my-0"}
8184

82-
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
83-
>
84-
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
85+
[Installation](/getting-started/installation)
8586

8687
#code
8788

8889
```mdc
89-
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
90-
>
91-
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
90+
[Installation](/getting-started/installation)
9291
```
9392

9493
::
9594

96-
## Links
95+
## Lists
9796

98-
To create a link, wrap the link text in brackets `[]()`.
97+
### Unordered
98+
99+
To create an unordered list, start each item with a `-`.
99100

100101
::code-preview{class="[&>div]:*:my-0"}
101102

102-
[Nuxt UI Pro](https://ui3.nuxt.dev/getting-started/installation/pro/nuxt)
103+
- I'm a list item.
104+
- I'm another list item.
105+
- I'm the last list item.
103106

104107
#code
105108

106109
```mdc
107-
[Nuxt UI Pro](https://ui3.nuxt.dev/getting-started/installation/pro/nuxt)
110+
- I'm a list item.
111+
- I'm another list item.
112+
- I'm the last list item.
108113
```
109114

110115
::
111116

112-
### Links to other pages
117+
### Ordered
113118

114-
Links to other pages of your documentation needs to be root-relative. For example, if you have a page called `getting-started/installation`, the link to that page should be `[Installation](/getting-started/installation)`.
119+
To create an ordered list, start each item with a number.
115120

116121
::code-preview{class="[&>div]:*:my-0"}
117122

118-
[Installation](/getting-started/installation)
123+
1. I'm a list item.
124+
2. I'm another list item.
125+
3. I'm the last list item.
119126

120127
#code
121128

122129
```mdc
123-
[Installation](/getting-started/installation)
130+
1. I'm a list item.
131+
2. I'm another list item.
132+
3. I'm the last list item.
133+
```
134+
135+
::
136+
137+
### Nested
138+
139+
To create a nested list, indent each item with four spaces.
140+
141+
::code-preview{class="[&>div]:*:my-0"}
142+
143+
- I'm a list item.
144+
- I'm a nested list item.
145+
- I'm another nested list item.
146+
- I'm another list item.
147+
148+
#code
149+
150+
```mdc
151+
- I'm a list item.
152+
- I'm a nested list item.
153+
- I'm another nested list item.
154+
- I'm another list item.
155+
```
156+
157+
::
158+
159+
## Tables
160+
161+
To create a table, use three or more hyphens (`---`) to separate each column.
162+
163+
::code-preview{class="[&>div]:*:my-0"}
164+
165+
| Prop | Default | Type |
166+
|---------|-----------|--------------------------|
167+
| `name` | | `string`{lang="ts-type"} |
168+
| `size` | `md` | `string`{lang="ts-type"} |
169+
| `color` | `neutral` | `string`{lang="ts-type"} |
170+
171+
#code
172+
173+
```mdc
174+
| Prop | Default | Type |
175+
|---------|-----------|--------------------------|
176+
| `name` | | `string`{lang="ts-type"} |
177+
| `size` | `md` | `string`{lang="ts-type"} |
178+
| `color` | `neutral` | `string`{lang="ts-type"} |
124179
```
125180

126181
::
182+
183+
## Blockquotes
184+
185+
### Singleline
186+
187+
To create a blockquote, add a `>` in front of a paragraph.
188+
189+
::code-preview{class="[&>div]:*:my-0"}
190+
191+
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
192+
193+
#code
194+
195+
```mdc
196+
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
197+
```
198+
199+
::
200+
201+
### Multiline
202+
203+
::code-preview{class="[&>div]:*:my-0"}
204+
205+
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
206+
>
207+
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
208+
209+
#code
210+
211+
```mdc
212+
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
213+
>
214+
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
215+
```
216+
217+
::
218+

0 commit comments

Comments
 (0)