Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit 0cd8a98

Browse files
author
Markus Falk
committed
[Task] edit docs
1 parent f156e74 commit 0cd8a98

File tree

1 file changed

+75
-84
lines changed

1 file changed

+75
-84
lines changed

README.md

Lines changed: 75 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,75 @@
1-
grid-layout
2-
===========
3-
4-
scss mixin for creating grid layouts
5-
6-
Docs
7-
----
8-
9-
```scss
10-
grid-layout($columns: 24, $sitewidth: 960, $margin: 20)
11-
```
12-
13-
HTML
14-
----
15-
16-
```html
17-
<h2>Example (xof24)</h2>
18-
<div class="cols24">
19-
<div class="col c8of24">&nbsp;</div>
20-
<div class="col c8of24">&nbsp;</div>
21-
<div class="col c8of24">&nbsp;</div>
22-
</div> <!-- cols -->
23-
24-
<h2>Columns with offset (xof24)</h2>
25-
<div class="cols24">
26-
<div class="col c8of24 offset8of24">&nbsp;</div>
27-
<div class="col c8of24">&nbsp;</div>
28-
</div> <!-- cols -->
29-
30-
<h2>Columns with offset (xof24)</h2>
31-
<div class="cols24">
32-
<div class="col c4of24">&nbsp;</div>
33-
<div class="col c16of24 offset4of24">&nbsp;</div>
34-
</div> <!-- cols -->
35-
36-
<h2>Columns with offset (xof24)</h2>
37-
<div class="cols24">
38-
<div class="col c4of24">&nbsp;</div>
39-
<div class="col c4of24">&nbsp;</div>
40-
<div class="col c4of24">&nbsp;</div>
41-
<div class="col c6of24 offset6of24">&nbsp;</div>
42-
</div> <!-- cols -->
43-
44-
<h2>Second set of columns (xof12)</h2>
45-
<div class="cols12">
46-
<div class="col c4of12">&nbsp;</div>
47-
<div class="col c8of12">&nbsp;</div>
48-
</div> <!-- cols -->
49-
50-
<h2>Second set of columns (xof12)</h2>
51-
<div class="cols12">
52-
<div class="col c8of12 offset4of12">&nbsp;</div>
53-
</div> <!-- cols -->
54-
```
55-
56-
SCSS
57-
----
58-
59-
Default:
60-
```scss
61-
/*
62-
generates a grid that has 24 columns with a 20px
63-
margin at 960px width
64-
*/
65-
66-
@include grid-layout();
67-
```
68-
69-
Advanced:
70-
```scss
71-
/*
72-
generates a grid that has 24 columns with a 10px
73-
margin at 1020px width
74-
*/
75-
76-
@include grid-layout(24, 1020, 10);
77-
```
78-
79-
Installation
80-
------------
81-
82-
```shell
83-
bower install grid-layout
84-
```
1+
# grid-layout
2+
3+
SCSS-mixin for creating grid layouts.
4+
5+
## HTML
6+
7+
```html
8+
<h2>Example (xof24)</h2>
9+
<div class="cols24">
10+
<div class="col c8of24">&nbsp;</div>
11+
<div class="col c8of24">&nbsp;</div>
12+
<div class="col c8of24">&nbsp;</div>
13+
</div> <!-- cols -->
14+
15+
<h2>Columns with offset (xof24)</h2>
16+
<div class="cols24">
17+
<div class="col c8of24 offset8of24">&nbsp;</div>
18+
<div class="col c8of24">&nbsp;</div>
19+
</div> <!-- cols -->
20+
21+
<h2>Columns with offset (xof24)</h2>
22+
<div class="cols24">
23+
<div class="col c4of24">&nbsp;</div>
24+
<div class="col c16of24 offset4of24">&nbsp;</div>
25+
</div> <!-- cols -->
26+
27+
<h2>Columns with offset (xof24)</h2>
28+
<div class="cols24">
29+
<div class="col c4of24">&nbsp;</div>
30+
<div class="col c4of24">&nbsp;</div>
31+
<div class="col c4of24">&nbsp;</div>
32+
<div class="col c6of24 offset6of24">&nbsp;</div>
33+
</div> <!-- cols -->
34+
35+
<h2>Second set of columns (xof12)</h2>
36+
<div class="cols12">
37+
<div class="col c4of12">&nbsp;</div>
38+
<div class="col c8of12">&nbsp;</div>
39+
</div> <!-- cols -->
40+
41+
<h2>Second set of columns (xof12)</h2>
42+
<div class="cols12">
43+
<div class="col c8of12 offset4of12">&nbsp;</div>
44+
</div> <!-- cols -->
45+
```
46+
47+
## SCSS
48+
49+
### Default
50+
51+
```scss
52+
/*
53+
Generates a grid that has 24 columns with a 20px
54+
margin at 960px width
55+
*/
56+
57+
@include grid-layout();
58+
```
59+
60+
### Advanced
61+
62+
```scss
63+
/*
64+
Generates a grid that has 24 columns with a 10px
65+
margin at 1020px width
66+
*/
67+
68+
@include grid-layout(24, 1020px, 10px);
69+
```
70+
71+
## Installation
72+
73+
```shell
74+
bower install grid-layout
75+
```

0 commit comments

Comments
 (0)