Skip to content

Commit dd8d75c

Browse files
committed
Add extended docs to README
Additional details to clarify the esoteric parts of normalize.css. Fix #353
1 parent 071af82 commit dd8d75c

File tree

1 file changed

+44
-12
lines changed

1 file changed

+44
-12
lines changed

README.md

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ normalizing.
1111

1212
## Install
1313

14-
Download from the [project page](http://necolas.github.io/normalize.css/).
14+
* [npm](http://npmjs.org/): `npm install --save normalize.css`
15+
* [Component(1)](https://github.com/component/component/): `component install necolas/normalize.css`
16+
* [Bower](http://bower.io/): `bower install --save normalize.css`
17+
* [Download](http://necolas.github.io/normalize.css/latest/normalize.css).
1518

16-
Install with [Component(1)](https://github.com/component/component/): `component install necolas/normalize.css`
17-
18-
Install with [npm](http://npmjs.org/): `npm install --save normalize.css`
19+
No other styles should come before Normalize.css.
1920

20-
Install with [Bower](http://bower.io/): `bower install --save normalize.css`
21+
It is recommended that you include the `normalize.css` file as untouched
22+
library code.
2123

2224
## What does it do?
2325

@@ -27,13 +29,6 @@ Install with [Bower](http://bower.io/): `bower install --save normalize.css`
2729
* Improves usability with subtle improvements.
2830
* Explains what code does using detailed comments.
2931

30-
## How to use it
31-
32-
No other styles should come before Normalize.css.
33-
34-
It is recommended that you include the `normalize.css` file as untouched
35-
library code.
36-
3732
## Browser support
3833

3934
* Google Chrome (latest)
@@ -47,6 +42,43 @@ library code.
4742
support](https://github.com/necolas/normalize.css/tree/v1) (IE 6+, Safari 4+),
4843
but is no longer actively developed.
4944

45+
## Extended details
46+
47+
Additional detail and explanation of the esoteric parts of normalize.css.
48+
49+
#### `pre, code, kbd, samp`
50+
51+
The `font-family: monospace, monospace` hack fixes the inheritance and scaling
52+
of font-size for preformated text. The duplication of `monospace` is
53+
intentional. [Source](http://en.wikipedia.org/wiki/User:Davidgothberg/Test59).
54+
55+
#### `sub, sup`
56+
57+
Normally, using `sub` or `sup` affects the line-box height of text in all
58+
browsers. [Source](http://gist.github.com/413930).
59+
60+
#### `svg:not(:root)`
61+
62+
Adding `overflow: hidden` fixes IE9's SVG rendering. Earlier versions of IE
63+
don't support SVG, so we can safely use the `:not()` and `:root` selectors that
64+
modern browsers use in the default UA stylesheets to apply this style. [SVG
65+
Mailing List discussion](http://lists.w3.org/Archives/Public/public-svg-wg/2008JulSep/0339.html)
66+
67+
#### `input[type="search"]`
68+
69+
The search input is not fully stylable by default. In Chrome and Safari on
70+
OSX/iOS you can't control `font`, `padding`, `border`, or `background`. In
71+
Chrome and Safari on Windows you can't control `border` properly. It will apply
72+
`border-width` but will only show a border color (which cannot be controlled)
73+
for the outer 1px of that border. Applying `-webkit-appearance: textfield`
74+
addresses these issues without removing the benefits of search inputs (e.g.
75+
showing past searches).
76+
77+
#### `legend`
78+
79+
Adding `border: 0` corrects an IE 8–11 bug where `color` (yes, `color`) is not
80+
inherited by `legend`.
81+
5082
## Contributing
5183

5284
Please read the CONTRIBUTING.md

0 commit comments

Comments
 (0)