Fix markdown syntax in README
This commit is contained in:
parent
03a340a225
commit
031b61b91e
34
README.md
34
README.md
@ -12,63 +12,65 @@ As an introduction to this system:
|
|||||||
|
|
||||||
1. Wrap everything in a div element with the `container` class.
|
1. Wrap everything in a div element with the `container` class.
|
||||||
|
|
||||||
'''html
|
```html
|
||||||
<div class="container"></div>
|
<div class="container"></div>
|
||||||
'''
|
```
|
||||||
|
|
||||||
2. To create rows add div elements with the `row` and `clearfix` classes.
|
2. To create rows add div elements with the `row` and `clearfix` classes.
|
||||||
|
|
||||||
'''html
|
```html
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="row clearfix"></div>
|
<div class="row clearfix"></div>
|
||||||
</div>
|
</div>
|
||||||
'''
|
```
|
||||||
|
|
||||||
2. To create columns add div elements with the `column` class. Then add a class
|
2. To create columns add div elements with the `column` class. Then add a class
|
||||||
to describe the width of the column with respect to the container. The possible
|
to describe the width of the column with respect to the container. The possible
|
||||||
widths are:
|
widths are:
|
||||||
|
|
||||||
* full: 100% width
|
CSS class name | width percentage
|
||||||
* two-thirds: 66.7% width
|
--------------- | ----------------
|
||||||
* half: 50% width
|
full | 100%
|
||||||
* third: 33.3% width
|
two-thirds | 66.7%
|
||||||
* fourth: 25% width
|
half | 50%
|
||||||
* three-fourths: 75% width
|
third | 33.3%
|
||||||
|
fourth | 25%
|
||||||
|
three-fourths | 75%
|
||||||
|
|
||||||
These are purely for convienence. A more precise width can be specified in the
|
These are purely for convienence. A more precise width can be specified in the
|
||||||
CSS if desired with the `width` attribute.
|
CSS if desired with the `width` attribute.
|
||||||
|
|
||||||
'''html
|
```html
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="row clearfix">
|
<div class="row clearfix">
|
||||||
<div class="column full"></div>
|
<div class="column full"></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
'''
|
```
|
||||||
|
|
||||||
3. Columns stack up right to left. To force a column out of order all the way to
|
3. Columns stack up right to left. To force a column out of order all the way to
|
||||||
the right use the `flow-opposite` class on the column.
|
the right use the `flow-opposite` class on the column.
|
||||||
|
|
||||||
'''html
|
```html
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="row clearfix">
|
<div class="row clearfix">
|
||||||
<div class="column half"></div>
|
<div class="column half"></div>
|
||||||
<div class="column half flow-opposite"></div>
|
<div class="column half flow-opposite"></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
'''
|
```
|
||||||
|
|
||||||
4. To hide an element on mobile phones add the class `hide-mobile`. To hide on
|
4. To hide an element on mobile phones add the class `hide-mobile`. To hide on
|
||||||
desktop, use `hide-desktop` instead.
|
desktop, use `hide-desktop` instead.
|
||||||
|
|
||||||
'''html
|
```html
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="row clearfix">
|
<div class="row clearfix">
|
||||||
<div class="column half hide-mobile"></div>
|
<div class="column half hide-mobile"></div>
|
||||||
<div class="column half hide-desktop"></div>
|
<div class="column half hide-desktop"></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
'''
|
```
|
||||||
|
|
||||||
5. Another note: I use [box-sizing (as suggested by Paul
|
5. Another note: I use [box-sizing (as suggested by Paul
|
||||||
Irish)](http://www.paulirish.com/2012/box-sizing-border-box-ftw/), which I think
|
Irish)](http://www.paulirish.com/2012/box-sizing-border-box-ftw/), which I think
|
||||||
|
Loading…
Reference in New Issue
Block a user