Skip to content

Commit

Permalink
More format fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Nico van Zyl authored Nov 4, 2018
1 parent e8715d1 commit d5adb00
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ All Wixel products/sites should use the HTML5 spec and therefore use `<!DOCTYPE

### Elements

### #Block elements
#### Block elements

Block elements should always have their opening and closing tags on single lines i.e.

Expand All @@ -70,15 +70,15 @@ Block elements should always have their opening and closing tags on single lines
</article>
```

### #Inline elements
#### Inline elements

Inline elements should be on single lines i.e.

```
<b>The content.</b>
```

### #Void elements
#### Void elements

Although fine with HTML, do not close void elements, i.e.,
Write `<br>` not `<br />`
Expand All @@ -105,15 +105,15 @@ rather use

Please check [when to use the button element](http://css-tricks.com/use-button-element/) to see why.

### #Multimedia fallback
#### Multimedia fallback

For multimedia, such as images, videos, animated objects via `canvas`, make sure to offer alternative access. For images that means use of meaningful alternative text (`alt`) and for video and audio transcripts and captions, if available.

Providing alternative contents is important for accessibility reasons: A blind user has few cues to tell what an image is about without `alt`, and other users may have no way of understanding what video or audio contents are about either.

(For images whose `alt` attributes would introduce redundancy, and for images whose purpose is purely decorative which you cannot immediately use CSS for, use no alternative text, as in `alt=""`.)

### #Keep it clean
#### Keep it clean

Try not to use any unnecessary elements.

Expand All @@ -125,7 +125,7 @@ rather use

`<script src="path/to/script.js" >Scroll to top</script>`

### #Quotation marks
#### Quotation marks

Use double `""` for HTML and single `''` for CSS and JS.

Expand All @@ -151,7 +151,7 @@ Never ever use a framework where there will be any unused styles or that you fin

For a simple front-end framework grab the [Wixel starter framework](https://github.com/Wixel/simple-wixel-starter-framework) to add to the project.

### #Nesting
#### Nesting

Never nest more than 3 levels deep. Nesting should also make logical sense i.e.

Expand Down Expand Up @@ -209,7 +209,7 @@ With the output css being:
}
```

### #Reusable class names
#### Reusable class names

Reusing common styles reduces your stylesheet size, the risk of overwriting properties and saving time in development.

Expand Down Expand Up @@ -251,7 +251,7 @@ Which you can then simply add to your block elements with `.bg-dark`, `.bg-light
}
```

### #Comments
#### Comments

Keep you SCSS code well documented with comments but don't compile comments into the CSS file except for licences or important notices that need to be shown in source.

Expand Down

0 comments on commit d5adb00

Please sign in to comment.