Skip to content

Commit 87cf7ed

Browse files
updates documentation
1 parent e22877a commit 87cf7ed

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ npm install -D @morsecodemedia/containers.css
2222
In the `nuxt.config.js` file
2323
```js
2424
css: [
25-
'@morsecodemedia/containers.css/dist/css/containers.css'
25+
'@morsecodemedia/containers.css'
2626
]
2727
```
2828

@@ -34,42 +34,53 @@ css: [
3434
* Safari 8+
3535
* Opera
3636

37-
## Containers Breakdown
38-
### 0px-767px
37+
## Containers
38+
Containers are the max-width areas in which content blocks can take up. Currently there are three (1-3), 1 being the widest and 3 being the most narrow.
39+
### A Visual Representation
40+
https://morsecodemedia.github.io/containers.css/
41+
42+
### Containers Breakdown
43+
44+
#### 0px-767px
3945
`.container1` 100% - 30px (15px on either side)
4046

4147
`.container2` 100% - 30px (15px on either side)
4248

4349
`.container3` 100% - 30px (15px on either side)
4450

45-
### 768px-991px
51+
#### 768px-991px
4652
`.container1` 100% - 50px (25px on either side)
4753

4854
`.container2` 100% - 70px (35px on either side)
4955

5056
`.container3` 100% - 110px (55px on either side)
5157

52-
### 992px-1199px
58+
#### 992px-1199px
5359
`.container1` 100% - 70px (35px on either side)
5460

5561
`.container2` 100% - 200px (100px on either side)
5662

5763
`.container3` 100% - 400px (200px on either side)
5864

59-
### 1200px-1399px
65+
#### 1200px-1399px
6066
`.container1` 100% - 100px (50px on either side)
6167

6268
`.container2` 100% - 300px (150px on either side)
6369

6470
`.container3` 100% - 500px (250px on either side)
6571

66-
### 1400px+
72+
#### 1400px+
6773
`.container1` max-width: 1300px
6874

6975
`.container2` max-width: 1000px
7076

7177
`.container3` max-width: 700px
7278

79+
## Gaps
80+
Gaps are vertical spacing used between columns to keep a consistent vertical rhythm among sections
81+
82+
### Gaps Breakdown
83+
7384
## Content Blocks
7485
`.half` `.half`
7586

@@ -88,6 +99,3 @@ css: [
8899
`.quarter` `.three-quarter`
89100

90101
`.three-quarter` `.quarter`
91-
92-
## TODO
93-
* Write up better documentation.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@morsecodemedia/containers.css",
3-
"version": "1.1.4",
3+
"version": "1.1.5",
44
"description": "A starting point for containers and gaps when you don't want to use Bootstrap and you can't go evergreen with CSS Grid.",
55
"main": "dist/css/containers.css",
66
"style": "dist/css/containers.css",

0 commit comments

Comments
 (0)