Skip to content
This repository was archived by the owner on Jul 18, 2024. It is now read-only.

Commit 6f1bc52

Browse files
committed
chore(readme): Update documentation to sound relevant to end user of grid
1 parent ab86c93 commit 6f1bc52

File tree

7 files changed

+20
-24
lines changed

7 files changed

+20
-24
lines changed

examples/bootstrap/css-gridish/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,11 @@ We provide the fixed height variables for items that are not direct children of
109109
}
110110
```
111111

112-
## Utility Mixin and Functions
113-
114-
Gridish has several utility SCSS functions and a mixin to help you add sizing to elements and components within your grid by using your own grid configuration.
115-
112+
## Mixins and Functions
116113

117114
### Media Query Mixin
118-
You can use the media query mixin to use breakpoints you've defined.
115+
116+
You can use the media query mixin to use breakpoints you’ve defined.
119117

120118
**Example SCSS**
121119
```scss
@@ -135,9 +133,10 @@ button {
135133
}
136134
```
137135

138-
Moreover, can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on your grid configuration.
136+
You can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on this grid.
139137

140138
### Get a Fluid Size
139+
141140
Use the `get-fluid-size()` SCSS function to calculate a fluid width based on: (1) a defined breakpoints, and (2) a number of columns to span, relative to the number of available columns for the given breakpoint.
142141

143142
**Example SCSS**
Binary file not shown.

examples/carbon/css-gridish/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,11 @@ We provide the fixed height variables for items that are not direct children of
109109
}
110110
```
111111

112-
## Utility Mixin and Functions
113-
114-
Gridish has several utility SCSS functions and a mixin to help you add sizing to elements and components within your grid by using your own grid configuration.
115-
112+
## Mixins and Functions
116113

117114
### Media Query Mixin
118-
You can use the media query mixin to use breakpoints you've defined.
115+
116+
You can use the media query mixin to use breakpoints you’ve defined.
119117

120118
**Example SCSS**
121119
```scss
@@ -135,9 +133,10 @@ button {
135133
}
136134
```
137135

138-
Moreover, can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on your grid configuration.
136+
You can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on this grid.
139137

140138
### Get a Fluid Size
139+
141140
Use the `get-fluid-size()` SCSS function to calculate a fluid width based on: (1) a defined breakpoints, and (2) a number of columns to span, relative to the number of available columns for the given breakpoint.
142141

143142
**Example SCSS**
3.16 KB
Binary file not shown.

examples/material/css-gridish/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,11 @@ We provide the fixed height variables for items that are not direct children of
113113
}
114114
```
115115

116-
## Utility Mixin and Functions
117-
118-
Gridish has several utility SCSS functions and a mixin to help you add sizing to elements and components within your grid by using your own grid configuration.
119-
116+
## Mixins and Functions
120117

121118
### Media Query Mixin
122-
You can use the media query mixin to use breakpoints you've defined.
119+
120+
You can use the media query mixin to use breakpoints you’ve defined.
123121

124122
**Example SCSS**
125123
```scss
@@ -139,9 +137,10 @@ button {
139137
}
140138
```
141139

142-
Moreover, can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on your grid configuration.
140+
You can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on this grid.
143141

144142
### Get a Fluid Size
143+
145144
Use the `get-fluid-size()` SCSS function to calculate a fluid width based on: (1) a defined breakpoints, and (2) a number of columns to span, relative to the number of available columns for the given breakpoint.
146145

147146
**Example SCSS**
Binary file not shown.

src/docs/README.md.hbs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,11 @@ We provide the fixed height variables for items that are not direct children of
109109
}
110110
```
111111
112-
## Utility Mixin and Functions
113-
114-
Gridish has several utility SCSS functions and a mixin to help you add sizing to elements and components within your grid by using your own grid configuration.
115-
112+
## Mixins and Functions
116113
117114
### Media Query Mixin
118-
You can use the media query mixin to use breakpoints you've defined.
115+
116+
You can use the media query mixin to use breakpoints you’ve defined.
119117
120118
**Example SCSS**
121119
```scss
@@ -135,9 +133,10 @@ button {
135133
}
136134
```
137135
138-
Moreover, can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on your grid configuration.
136+
You can then **combine this mixin with the functions below** to construct media queries that set fluid and fixed sizes based on this grid.
139137
140138
### Get a Fluid Size
139+
141140
Use the `get-fluid-size()` SCSS function to calculate a fluid width based on: (1) a defined breakpoints, and (2) a number of columns to span, relative to the number of available columns for the given breakpoint.
142141
143142
**Example SCSS**

0 commit comments

Comments
 (0)