Skip to content

Commit f7b6448

Browse files
committed
update readme link
1 parent 7cb8e65 commit f7b6448

File tree

1 file changed

+28
-32
lines changed

1 file changed

+28
-32
lines changed

README.md

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Power Tools For The Web [Deprecated]
2-
====================================
1+
# Power Tools For The Web [Deprecated]
32

43
**Susy is Deprecated. It should no longer be used on new projects, and will no longer be receiving any updates.**
54

@@ -21,9 +20,7 @@ functions that can be used to build any grid system.
2120
- [Susy3 Documentation](http://oddbird.net/susy/docs/)
2221
- [Susy1/Susy2 Documentation](http://susy.readthedocs.io)
2322

24-
25-
Quotes
26-
------
23+
## Quotes
2724

2825
> "I like the idea of grids-on-demand,
2926
> rather than a strict framework."<br />
@@ -37,24 +34,19 @@ Quotes
3734
> be sure to look at Susy’s source code!"<br />
3835
> — Kitty Giraudel, [SitePoint](http://www.sitepoint.com/my-favorite-sass-tools/)
3936
40-
41-
Resources
42-
---------
37+
## Resources
4338

4439
- [OddBird](http://oddbird.net/) | [@OddBird](http://twitter.com/oddbird/)
4540
- [Sites using Susy](http://oddbird.net/susy/sites/)
4641
- [Changelog](https://github.com/oddbird/susy/blob/main/CHANGELOG.md)
4742
- [Guidelines for contributing](https://github.com/oddbird/susy/blob/main/CONTRIBUTING.md)
4843
- [BSD3 License](https://github.com/oddbird/susy/blob/main/LICENSE.txt)
4944

50-
Third-Party Tools
51-
-----------------
45+
## Third-Party Tools
5246

5347
- [Susy.js](https://github.com/ignota/susy.js) CSS-in-JS port
5448

55-
56-
Installation
57-
------------
49+
## Installation
5850

5951
```
6052
npm install susy
@@ -74,14 +66,12 @@ import `sass/susy-prefix` instead.
7466
@import '<path-to>/susy/sass/susy-prefix';
7567
```
7668

77-
7869
### Using [Eyeglass](http://eyeglass.rocks/)
7970

8071
With eyeglass set up,
8172
you can `@import 'susy';`
8273
without providing the npm-modules path.
8374

84-
8575
### Using Webpack
8676

8777
Make sure `sass-loader` is installed:
@@ -98,33 +88,35 @@ module: {
9888
rules: [
9989
{
10090
test: /\.scss$/,
101-
use: ['style-loader', 'css-loader', 'sass-loader']
102-
}
103-
]
91+
use: ['style-loader', 'css-loader', 'sass-loader'],
92+
},
93+
];
10494
}
10595
```
10696

10797
Start using Susy:
10898

10999
```scss
110100
/* app.scss */
111-
@import "~susy/sass/susy";
101+
@import '~susy/sass/susy';
112102
```
113103

114-
115104
### Using Gulp
116105

117106
Add a gulp task:
118107

119108
```javascript
120109
// gulpfile.js
121-
gulp.task('sass', function() {
122-
return gulp.src('scss/*.scss')
123-
.pipe(sass({
124-
outputStyle: 'compressed',
125-
includePaths: ['node_modules/susy/sass']
126-
}).on('error', sass.logError))
127-
.pipe(gulp.dest('dist/css'));
110+
gulp.task('sass', function () {
111+
return gulp
112+
.src('scss/*.scss')
113+
.pipe(
114+
sass({
115+
outputStyle: 'compressed',
116+
includePaths: ['node_modules/susy/sass'],
117+
}).on('error', sass.logError),
118+
)
119+
.pipe(gulp.dest('dist/css'));
128120
});
129121
```
130122

@@ -168,9 +160,7 @@ Start using Susy:
168160
@import 'susy';
169161
```
170162

171-
172-
Susy vs Su
173-
----------
163+
## Susy vs Su
174164

175165
You may notice that some functions have a `susy-` prefix,
176166
while others only have `su-`.
@@ -187,9 +177,15 @@ This helps distinguish between the two distinct layers:
187177
that call on the core math as necessary.
188178
This is the primary API for most users.
189179

190-
_____
180+
---
181+
191182
### Sponsor OddBird's OSS Work
192183

193-
At OddBird, we love contributing to the languages & tools developers rely on. We're currently working on polyfills for new Popover & Anchor Positioning functionality, as well as CSS specifications for functions, mixins, and responsive typography. Help us keep this work sustainable and centered on your needs as a developer! We display sponsor logos and avatars on our website.
184+
At OddBird, we love contributing to the languages & tools developers rely on.
185+
We're currently working on polyfills for new Popover & Anchor Positioning
186+
functionality, as well as CSS specifications for functions, mixins, and
187+
responsive typography. Help us keep this work sustainable and centered on your
188+
needs as a developer! We display sponsor logos and avatars on our
189+
[website](https://www.oddbird.net/susy/#open-source-sponsors).
194190

195191
[Sponsor OddBird's OSS Work](https://opencollective.com/oddbird-open-source)

0 commit comments

Comments
 (0)