Skip to content

Commit 02f5f08

Browse files
committed
Polish component example docs
1 parent 9887a13 commit 02f5f08

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

docs/source/docs/examples/alerts.blade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
extends: _layouts.documentation
33
title: "Alerts"
4-
description: null
4+
description: Examples of building alert components with Tailwind CSS.
55
---
66

7-
@include('_partials.work-in-progress-example')
7+
Tailwind doesn't include pre-designed alert components out of the box, but they're easy to build using existing utilities.
88

99
### Traditional
1010

docs/source/docs/examples/buttons.blade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
extends: _layouts.documentation
33
title: "Buttons"
4-
description: null
4+
description: Examples of building buttons with Tailwind CSS.
55
---
66

7-
@include('_partials.work-in-progress-example')
7+
Tailwind doesn't include pre-designed button styles out of the box, but they're easy to build using existing utilities.
88

99
### Simple
1010

docs/source/docs/examples/cards.blade.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
extends: _layouts.documentation
33
title: "Cards"
4-
description: null
4+
description: Examples of building card components with Tailwind CSS.
55
---
66

7-
@include('_partials.work-in-progress-example')
7+
Tailwind doesn't include pre-designed card components out of the box, but they're easy to build using existing utilities.
88

9-
## Stacked
9+
### Stacked
1010

1111
@component('_partials.code-sample', ['class' => 'p-10 flex justify-center'])
1212
<div class="max-w-sm rounded overflow-hidden shadow-lg">
@@ -25,7 +25,7 @@ description: null
2525
</div>
2626
@endcomponent
2727

28-
## Horizontal
28+
### Horizontal
2929

3030
@component('_partials.code-sample', ['class' => 'p-10 flex justify-center'])
3131
<div class="max-w-md w-full lg:flex">

docs/source/docs/examples/forms.blade.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
extends: _layouts.documentation
33
title: "Forms"
4-
description: null
4+
description: Examples of building forms with Tailwind CSS.
55
---
66

7-
@include('_partials.work-in-progress-example')
7+
Tailwind doesn't include purpose-built form control classes out of the box, but form controls are easy to style using existing utilities.
88

9-
## Login Form
9+
### Login Form
1010

1111
@component('_partials.code-sample', ['class' => 'px-3 py-10 bg-grey-lighter flex justify-center'])
1212
<div class="w-full max-w-xs">
@@ -39,7 +39,7 @@ description: null
3939
</div>
4040
@endcomponent
4141

42-
## Inline Form
42+
### Inline Form
4343

4444
@component('_partials.code-sample', ['class' => 'flex justify-center p-8'])
4545
<form class="w-full max-w-xs">
@@ -83,7 +83,7 @@ description: null
8383
</form>
8484
@endcomponent
8585

86-
## Form Grid
86+
### Form Grid
8787

8888
@component('_partials.code-sample', ['class' => 'flex justify-center p-8'])
8989
<form class="w-full max-w-md">
@@ -143,7 +143,7 @@ description: null
143143
</form>
144144
@endcomponent
145145

146-
## Underline Form
146+
### Underline Form
147147

148148
@component('_partials.code-sample', ['class' => 'flex justify-center p-8'])
149149
<form class="w-full max-w-sm">

docs/source/docs/examples/navigation.blade.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
extends: _layouts.documentation
33
title: "Navigation"
4-
description: null
4+
description: Examples of building navigation components with Tailwind CSS.
55
---
66

7-
@include('_partials.work-in-progress-example')
7+
Tailwind doesn't include pre-designed navigation components out of the box, but they're easy to build using existing utilities.
88

9-
## Simple
9+
### Simple
1010

1111
@component('_partials.code-sample')
1212
<ul class="list-reset flex">
@@ -25,7 +25,7 @@ description: null
2525
</ul>
2626
@endcomponent
2727

28-
## Responsive Header
28+
### Responsive Header
2929

3030
@component('_partials.code-sample')
3131
<nav class="flex items-center justify-between flex-wrap bg-teal p-6">
@@ -57,7 +57,7 @@ description: null
5757
</nav>
5858
@endcomponent
5959

60-
## Tabs
60+
### Tabs
6161

6262
@component('_partials.code-sample')
6363
<ul class="list-reset flex border-b">
@@ -76,7 +76,7 @@ description: null
7676
</ul>
7777
@endcomponent
7878

79-
## Pills
79+
### Pills
8080

8181
@component('_partials.code-sample')
8282
<ul class="list-reset flex">
@@ -92,7 +92,7 @@ description: null
9292
</ul>
9393
@endcomponent
9494

95-
## Stretched
95+
### Stretched
9696

9797
@component('_partials.code-sample')
9898
<ul class="list-reset flex">
@@ -108,7 +108,7 @@ description: null
108108
</ul>
109109
@endcomponent
110110

111-
## Justified
111+
### Justified
112112

113113
@component('_partials.code-sample')
114114
<ul class="list-reset flex justify-between">

0 commit comments

Comments
 (0)