Skip to content

Commit 7a1bbd7

Browse files
committed
update document
1 parent c7b72c9 commit 7a1bbd7

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

doc/index.html

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ <h1 class="header-title">Flexbox Grid Mixins <span class="version">v.0.1.2</span
2121
<li><a href="#License">License</a></li>
2222
</ul>
2323

24+
<ul class="header-nav">
25+
<li><a href="https://github.com/thingsym/flexbox-grid-mixins" class="btn">GitHub</a></li>
26+
<li><a href="https://www.npmjs.com/package/flexbox-grid-mixins" class="btn">npm</a></li>
27+
</ul>
28+
2429
</div>
2530

2631
<h2>Feature</h2>
@@ -79,9 +84,6 @@ <h3>CSS</h3>
7984
display: -webkit-flex;
8085
display: -ms-flexbox;
8186
display: flex;
82-
-webkit-flex-flow: row nowrap;
83-
-ms-flex-flow: row nowrap;
84-
flex-flow: row nowrap;
8587
margin: 0 -1%;
8688
}
8789

@@ -257,9 +259,6 @@ <h3>CSS</h3>
257259
display: -webkit-flex;
258260
display: -ms-flexbox;
259261
display: flex;
260-
-webkit-flex-flow: row nowrap;
261-
-ms-flex-flow: row nowrap;
262-
flex-flow: row nowrap;
263262
margin: 0 -1%;
264263
}
265264

@@ -420,7 +419,7 @@ <h3>3. Generate the grid columns</h3>
420419

421420
<h2 id="Mixins-Reference">Mixins Reference</h2>
422421

423-
<h3 class="reference"><span class="small">@include</span> <span class="big">grid</span>($display: flex, $flex-flow: row nowrap, $justify-content: null, $align-items: null, $align-content: null, $gutter: null, $grid-type: skeleton);</h3>
422+
<h3 class="reference"><span class="small">@include</span> <span class="big">grid</span>($display: flex, $flex-direction: null, $flex-wrap: null, $flex-flow: null, $justify-content: null, $align-items: null, $align-content: null, $gutter: null, $grid-type: skeleton);</h3>
424423

425424
<p>Define the grid container.</p>
426425

@@ -438,9 +437,21 @@ <h3 class="reference"><span class="small">@include</span> <span class="big">grid
438437
<td>generate a block-level or an inline-level grid container</td>
439438
</tr>
440439
<tr>
440+
<td>$flex-direction</td>
441+
<td>null</td>
442+
<td>null | row | row-reverse | column | column-reverse</td>
443+
<td></td>
444+
</tr>
445+
<tr>
446+
<td>$flex-wrap</td>
447+
<td>null</td>
448+
<td>null | nowrap | wrap | wrap-reverse</td>
449+
<td></td>
450+
</tr>
451+
<tr>
441452
<td>$flex-flow</td>
442-
<td>row nowrap *</td>
443-
<td>[row | row-reverse | column | column-reverse] [nowrap | wrap | wrap-reverse]</td>
453+
<td>null</td>
454+
<td>null | [row | row-reverse | column | column-reverse] [nowrap | wrap | wrap-reverse]</td>
444455
<td>a shorthand for setting the flex-direction and flex-wrap properties</td>
445456
</tr>
446457
<tr>
@@ -475,13 +486,11 @@ <h3 class="reference"><span class="small">@include</span> <span class="big">grid
475486
</tr>
476487
</table>
477488

478-
* The same initial value as the property of Flexbox
479-
480489
<h3 class="reference"><span class="small">@include</span> <span class="big">grid-col</span>($col: null, $grid-columns: 12, $col-offset: null, $gutter: null, $condensed: false, $align-self: null, $flex-grow: 0, $flex-shrink: 1, $flex-basis: auto, $order: null, $grid-type: skeleton, $last-child: false);</h3>
481490

482491
<p>Generate the grid columns.</p>
483492

484-
<p>The use of CSS cal() is experimental stage. If $col sets <code>&lt;number&gt;</code> and $gutter sets <code>&lt;length&gt;</code>, use CSS cal().</p>
493+
<p>The use of CSS calc() is experimental stage. If $col sets <code>&lt;number&gt;</code> or <code>&lt;width&gt;</code> and $gutter sets <code>&lt;length&gt;</code>, use CSS calc().</p>
485494

486495
<table>
487496
<tr>
@@ -564,7 +573,7 @@ <h3 class="reference"><span class="small">@include</span> <span class="big">grid
564573
</tr>
565574
</table>
566575

567-
* The same initial value as the property of Flexbox
576+
<p>* The same initial value as the property of Flexbox</p>
568577

569578
<h3 class="reference"><span class="small">@include</span> <span class="big">grid-margin</span>($margin: null, $margin-top: null, $margin-right: null, $margin-bottom: null, $margin-left: null);</h3>
570579

0 commit comments

Comments
 (0)