You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 29, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+56-47Lines changed: 56 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,23 +19,30 @@ e.
19
19
20
20
- a guide at the top, right, bottom, and left of the document.
21
21
22
-
| ~ | (v)
23
-
| ~ | (h)
22
+
```
23
+
| ~ | (v)
24
+
| ~ | (h)
25
+
```
24
26
25
27
26
28
- a three row vertical grid
27
29
28
-
| ~ | ~ | ~ | ( v )
30
+
```
31
+
| ~ | ~ | ~ | ( v )
32
+
```
29
33
30
34
31
35
- a one hundred pixel horizontal grid with a ten pixel left margin, ten pixel right margin, and a twenty pixel column centered in the middle
32
36
33
-
| 10px | ~ | 20px | ~ | 10px| ( h, 100px )
34
-
37
+
```
38
+
| 10px | ~ | 20px | ~ | 10px| ( h, 100px )
39
+
```
35
40
36
41
- a grid with a left side bar with 10px on either side, and a five columns filling the gap.
37
42
38
-
| 10px | 200px | 10px | ~ | ~ | ~ |
43
+
```
44
+
| 10px | 200px | 10px | ~ | ~ | ~ |
45
+
```
39
46
40
47
## Unit objects
41
48
@@ -69,11 +76,14 @@ An arbitrary gap is represented by a Unit Object and an optional multiplier. Arb
69
76
70
77
#### Examples
71
78
72
-
-`| 10px | 10px | 10px|`
73
-
three ten pixel columns
79
+
- three ten pixel columns
80
+
81
+
`| 10px | 10px | 10px|`
82
+
83
+
84
+
- one half inch column, one inch column, one half inch column
74
85
75
-
-`| .5in | 1in | .5in |`
76
-
one half inch column, one inch column, one half inch column
86
+
`| .5in | 1in | .5in |`
77
87
78
88
### Wildcard gaps
79
89
@@ -83,11 +93,13 @@ Due to their flexible nature, wildcards can be used to position a grid. When a s
83
93
84
94
#### Examples
85
95
86
-
-`| ~ |`
87
-
A guide on the left and right side of the document or selection.
96
+
- A guide on the left and right side of the document or selection.
88
97
89
-
-`| ~ | ~ | ~ |`
90
-
A three column grid
98
+
`| ~ |`
99
+
100
+
- A three column grid
101
+
102
+
`| ~ | ~ | ~ |`
91
103
92
104
### Variables
93
105
@@ -133,24 +145,27 @@ A multiple is represented by an asterisk `*` followed by a number. The hunk will
133
145
134
146
#### Examples
135
147
136
-
-`| ~*2 | ~ |`
137
-
Two thirds column, one third column
148
+
- Two thirds column, one third column
149
+
150
+
`| ~*2 | ~ |`
138
151
139
-
-```
152
+
- A three column grid with ten pixel gutters
153
+
154
+
```
140
155
$ = ~ | 10px |
141
156
| $*2 ~ |
142
157
```
143
-
A three column grid with ten pixel gutters
144
158
145
159
#### Fill
146
160
147
161
A fill is represented by a asterisk `*` folowed by nothing and is a gap that will be recreated squentially until it fills the remaining space in the grid. This is useful for cases such as creating a baseline grid, or filling a space with as many columns and gutters of a certain width as will fit.
148
162
149
-
-```
163
+
- A sixteen pixel baseline grid
164
+
165
+
```
150
166
$ = 16px |
151
167
| $* ( v )
152
-
```
153
-
A sixteen pixel baseline grid
168
+
```
154
169
155
170
156
171
## Grid Options
@@ -163,53 +178,43 @@ Determines the direction the grid will be rendered, whether horizontal or vertic
163
178
164
179
#### Values:
165
180
166
-
-`h`*(default)*
167
-
horizontal
181
+
-`h`*(default)* horizontal
168
182
169
-
-`v`
170
-
vertical
183
+
-`v` vertical
171
184
172
185
### Position
173
186
174
187
Determines the position where GuideGuide renders the grid in cases where the grid specified is not as wide as the document or selection. Note the capital letters.
175
188
176
189
#### Values:
177
190
178
-
-`F`*(default)*
179
-
first (left/top)
191
+
-`F`*(default)* first (left/top)
180
192
181
-
-`C`
182
-
center
193
+
-`C` center
183
194
184
-
-`L`
185
-
last (right/bottom)
195
+
-`L` last (right/bottom)
186
196
187
197
### Remainder pixel distribution
188
198
189
199
Determines to which wildcards GuideGuide adds remainder pixels when the columns do not divide equally into the total width of the grid area. Note the lowercase letters.
190
200
191
201
#### Values:
192
202
193
-
-`f`*(default)*
194
-
first (left/top)
203
+
-`f`*(default)* first (left/top)
195
204
196
-
-`c`
197
-
center
205
+
-`c` center
198
206
199
-
-`l`
200
-
last (right/bottom)
207
+
-`l` last (right/bottom)
201
208
202
209
### Calculation
203
210
204
211
Determines whether GuideGuide is strict about integers when calculating pixels
205
212
206
213
#### Values:
207
214
208
-
-`n`*(default)*
209
-
normal
215
+
-`n`*(default)* normal
210
216
211
-
-`p`
212
-
pixel specific
217
+
-`p` pixel specific
213
218
214
219
### Grid width
215
220
@@ -226,14 +231,18 @@ Optional unit object that specifies how far from the origin the grid will be off
226
231
227
232
#### Examples
228
233
229
-
-`| 10px | ( hF, , 50px )`
230
-
A ten pixel column that sits 50px from the left side of the document/selection
234
+
- A ten pixel column that sits 50px from the left side of the document/selection
235
+
236
+
`| 10px | ( hF, , 50px )`
237
+
238
+
239
+
- A ten pixel column that sits 50px from the right site of the doucment/selection
240
+
241
+
`| 10px | ( hL, , 50px )`
231
242
232
-
-`| 10px | ( hL, , 50px )`
233
-
A ten pixel column that sits 50px from the right site of the doucment/selection
243
+
- A ten pixel wide column that sits 30px from the right side of a 100px selection.
234
244
235
-
-`| 10px | ( hL, 100px, 30px)`
236
-
A ten pixel wide column that sits 30px from the right side of a 100px selection.
0 commit comments