Skip to content

Commit a49099f

Browse files
committed
Update README.md
1 parent 0e0d498 commit a49099f

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,12 @@ $DBmodal-background: #fff !default;
7575
$DBmodal-background-alt: color(gray, x-light) !default;
7676

7777
.o-modal { ... }
78+
7879
// Many lines later...
79-
// EXPERIMENT: gandalf-rule-name
80+
81+
// EXPERIMENT: experiment-rule-name
8082
.o-modal--experiment { ... }
81-
// END EXPERIMENT: gandalf-rule-name
83+
// END EXPERIMENT: experiment-rule-name
8284
```
8385

8486
### Variables
@@ -115,12 +117,13 @@ Example:
115117

116118
### Experiments
117119

118-
- Wrap experiment styles with comments:
119-
```scss
120-
// EXPERIMENT: gandalf-rule-name
121-
.stuff { ... }
122-
// END EXPERIMENT: gandalf-rule-name
123-
```
120+
Wrap experiment styles with comments:
121+
122+
```scss
123+
// EXPERIMENT: experiment-rule-name
124+
.stuff { ... }
125+
// END EXPERIMENT: experiment-rule-name
126+
```
124127

125128
----------
126129

@@ -201,18 +204,16 @@ Nesting can be really easily avoided by smart class naming (with the help of BEM
201204
## BEM
202205

203206
Block: Unique, meaningful names for a logical unit of style. Avoid excessive shorthand.
204-
Good: ".alert-box" or ".expanding-section" or ".button"
205-
Bad: ".feature" or ".content" or ".btn"
207+
- Good: `.alert-box` or `.recents-intro` or `.button`
208+
- Bad: `.feature` or `.content` or `.btn`
206209

207-
Element: styles that only apply to children of a block. Elements can also be blocks themselves. Class name is a concatenation of the block name, two underscores and the element name.
208-
Examples:
209-
".alert-box__close"
210-
".expanding-section__section"
210+
Element: styles that only apply to children of a block. Elements can also be blocks themselves. Class name is a concatenation of the block name, two underscores and the element name. Examples:
211+
- `.alert-box__close`
212+
- `.expanding-section__section`
211213

212-
Modifier: override or extend the base styles of a block or element with modifier styles. Class name is a concatenation of the block (or element) name, two hyphens and the modifier name.
213-
Examples:
214-
".alert-box--success"
215-
".expanding-section--expanded"
214+
Modifier: override or extend the base styles of a block or element with modifier styles. Class name is a concatenation of the block (or element) name, two hyphens and the modifier name. Examples:
215+
- `.alert-box--success`
216+
- `.expanding-section--expanded`
216217

217218
### BEM Best practices
218219

@@ -329,7 +330,7 @@ $SCREEN_SM_MAX: "max-width: 767px";
329330
.selector {
330331
float: left;
331332

332-
@media only screen and ($SMALL_BELOW) {
333+
@media only screen and ($SCREEN_SM_MAX) {
333334
float: none;
334335
}
335336
}

0 commit comments

Comments
 (0)