Skip to content

Commit a2d0ae6

Browse files
committed
Merge pull request #179 from anolson/remove_deprecated_methods_from_readme
Remove deprecated methods from readme
2 parents 0fcdff8 + 1d1c000 commit a2d0ae6

File tree

1 file changed

+40
-24
lines changed

1 file changed

+40
-24
lines changed

README.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -43,30 +43,46 @@ primitive and do not work well with Sass files. Instead, use Sass's native `@imp
4343

4444
## Features
4545

46-
* **Glob Imports**. When in Rails, there is a special import syntax that allows you to
47-
glob imports relative to the folder of the stylesheet that is doing the importing.
48-
E.g. `@import "mixins/*"` will import all the files in the mixins folder and
49-
`@import "mixins/**/*"` will import all the files in the mixins tree.
50-
Any valid ruby glob may be used. The imports are sorted alphabetically.
51-
**NOTE:** It is recommended that you only use this when importing pure library
52-
files (containing mixins and variables) because it is difficult to control the
53-
cascade ordering for imports that contain styles using this approach.
54-
55-
* **Asset Helpers**. When using the asset pipeline, paths to assets must be rewritten.
56-
When referencing assets use the following asset helpers (underscored in Ruby, hyphenated
57-
in Sass):
58-
59-
* `asset-path($relative-asset-path, $asset-class)` - Returns a string to the asset.
60-
For example: `asset-path("rails.png", image)` becomes `"/assets/rails.png"`
61-
* `asset-url($relative-asset-path, $asset-class)` - Returns url reference to the asset.
62-
For example: `asset-url("rails.png", image)` becomes `url(/assets/rails.png)`
63-
* As a convenience, for each of the following asset classes there are
64-
corresponding `-path` and `-url` helpers:
65-
image, font, video, audio, javascript, stylesheet.
66-
For example: `image-url("rails.png")` becomes `url(/assets/rails.png)` and
67-
`image-path("rails.png")` becomes `"/assets/rails.png"`.
68-
* `asset-data-url($relative-asset-path)` - Returns url reference to the Base64-encoded asset at the specified path.
69-
For example: `asset-data-url("rails.png")` becomes `url(data:image/png;base64,iVBORw0K...)`
46+
### Glob Imports
47+
48+
When in Rails, there is a special import syntax that allows you to
49+
glob imports relative to the folder of the stylesheet that is doing the importing.
50+
51+
* `@import "mixins/*"` will import all the files in the mixins folder
52+
* `@import "mixins/**/*"` will import all the files in the mixins tree
53+
54+
Any valid ruby glob may be used. The imports are sorted alphabetically.
55+
56+
**NOTE:** It is recommended that you only use this when importing pure library
57+
files (containing mixins and variables) because it is difficult to control the
58+
cascade ordering for imports that contain styles using this approach.
59+
60+
### Asset Helpers
61+
When using the asset pipeline, paths to assets must be rewritten.
62+
When referencing assets use the following asset helpers (underscored in Ruby, hyphenated
63+
in Sass):
64+
65+
#### `asset-path($relative-asset-path)`
66+
Returns a string to the asset.
67+
68+
* `asset-path("rails.png")` becomes `"/assets/rails.png"`
69+
70+
#### `asset-url($relative-asset-path)`
71+
Returns a url reference to the asset.
72+
73+
* `asset-url("rails.png")` becomes `url(/assets/rails.png)`
74+
75+
As a convenience, for each of the following asset classes there are
76+
corresponding `-path` and `-url` helpers:
77+
image, font, video, audio, javascript, stylesheet.
78+
79+
* `image-path("rails.png")` becomes `"/assets/rails.png"`
80+
* `image-url("rails.png")` becomes `url(/assets/rails.png)`
81+
82+
#### `asset-data-url($relative-asset-path)`
83+
Returns a url reference to the Base64-encoded asset at the specified path.
84+
85+
* `asset-data-url("rails.png")` becomes `url(data:image/png;base64,iVBORw0K...)`
7086

7187
## Running Tests
7288

0 commit comments

Comments
 (0)