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

Commit 2d6e071

Browse files
committed
reorder examples
1 parent 601cb4c commit 2d6e071

File tree

1 file changed

+56
-47
lines changed

1 file changed

+56
-47
lines changed

README.md

Lines changed: 56 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,30 @@ e.
1919

2020
- a guide at the top, right, bottom, and left of the document.
2121

22-
| ~ | (v)
23-
| ~ | (h)
22+
```
23+
| ~ | (v)
24+
| ~ | (h)
25+
```
2426

2527

2628
- a three row vertical grid
2729

28-
| ~ | ~ | ~ | ( v )
30+
```
31+
| ~ | ~ | ~ | ( v )
32+
```
2933

3034

3135
- 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
3236

33-
| 10px | ~ | 20px | ~ | 10px| ( h, 100px )
34-
37+
```
38+
| 10px | ~ | 20px | ~ | 10px| ( h, 100px )
39+
```
3540

3641
- a grid with a left side bar with 10px on either side, and a five columns filling the gap.
3742

38-
| 10px | 200px | 10px | ~ | ~ | ~ |
43+
```
44+
| 10px | 200px | 10px | ~ | ~ | ~ |
45+
```
3946

4047
## Unit objects
4148

@@ -69,11 +76,14 @@ An arbitrary gap is represented by a Unit Object and an optional multiplier. Arb
6976

7077
#### Examples
7178

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
7485

75-
- `| .5in | 1in | .5in |`
76-
one half inch column, one inch column, one half inch column
86+
`| .5in | 1in | .5in |`
7787

7888
### Wildcard gaps
7989

@@ -83,11 +93,13 @@ Due to their flexible nature, wildcards can be used to position a grid. When a s
8393

8494
#### Examples
8595

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.
8897

89-
- `| ~ | ~ | ~ |`
90-
A three column grid
98+
`| ~ |`
99+
100+
- A three column grid
101+
102+
`| ~ | ~ | ~ |`
91103

92104
### Variables
93105

@@ -133,24 +145,27 @@ A multiple is represented by an asterisk `*` followed by a number. The hunk will
133145

134146
#### Examples
135147

136-
- `| ~*2 | ~ |`
137-
Two thirds column, one third column
148+
- Two thirds column, one third column
149+
150+
`| ~*2 | ~ |`
138151

139-
- ```
152+
- A three column grid with ten pixel gutters
153+
154+
```
140155
$ = ~ | 10px |
141156
| $*2 ~ |
142157
```
143-
A three column grid with ten pixel gutters
144158

145159
#### Fill
146160

147161
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.
148162

149-
- ```
163+
- A sixteen pixel baseline grid
164+
165+
```
150166
$ = 16px |
151167
| $* ( v )
152-
```
153-
A sixteen pixel baseline grid
168+
```
154169

155170

156171
## Grid Options
@@ -163,53 +178,43 @@ Determines the direction the grid will be rendered, whether horizontal or vertic
163178

164179
#### Values:
165180

166-
- `h` *(default)*
167-
horizontal
181+
- `h` *(default)* horizontal
168182

169-
- `v`
170-
vertical
183+
- `v` vertical
171184

172185
### Position
173186

174187
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.
175188

176189
#### Values:
177190

178-
- `F`*(default)*
179-
first (left/top)
191+
- `F`*(default)* first (left/top)
180192

181-
- `C`
182-
center
193+
- `C` center
183194

184-
- `L`
185-
last (right/bottom)
195+
- `L` last (right/bottom)
186196

187197
### Remainder pixel distribution
188198

189199
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.
190200

191201
#### Values:
192202

193-
- `f`*(default)*
194-
first (left/top)
203+
- `f`*(default)* first (left/top)
195204

196-
- `c`
197-
center
205+
- `c` center
198206

199-
- `l`
200-
last (right/bottom)
207+
- `l` last (right/bottom)
201208

202209
### Calculation
203210

204211
Determines whether GuideGuide is strict about integers when calculating pixels
205212

206213
#### Values:
207214

208-
- `n` *(default)*
209-
normal
215+
- `n` *(default)* normal
210216

211-
- `p`
212-
pixel specific
217+
- `p` pixel specific
213218

214219
### Grid width
215220

@@ -226,14 +231,18 @@ Optional unit object that specifies how far from the origin the grid will be off
226231

227232
#### Examples
228233

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 )`
231242

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.
234244

235-
- `| 10px | ( hL, 100px, 30px)`
236-
A ten pixel wide column that sits 30px from the right side of a 100px selection.
245+
`| 10px | ( hL, 100px, 30px)`
237246

238247
## Errors
239248

0 commit comments

Comments
 (0)