Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Susy to 1.0 #3

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 60 additions & 40 deletions SASS.lrplugin/lib/susy/CHANGELOG.mkdn
Original file line number Diff line number Diff line change
@@ -1,64 +1,84 @@
Susy Changelog
==============

v1.0 [UNRELEASED]
-----------------
v1.0 [Aug 14, 2012]
-------------------

This release is loaded with new features, but don't let that fool you. Susy
just became shockingly simple to use. See the [website][site] for details.

Note that the gem name has changed from `compass-susy-plugin` to `susy`.
The gem name has changed from `compass-susy-plugin` to `susy`.
First uninstall the old gem, then install the new one.
If you have both gems installed, you will get errors.

[site]: http://susy.oddbird.net/

New Features:

* `omega` can now be set directly through the `columns` mixin for much
more compact output.
* Create responsive grid break-points using `at-breakpoint` and `layout`.
* `container` mixin now accepts one or more grids/breakpoints as a shortcut.
* All mixins respect your `$legacy-support-for-ie` settings.
* The `space` function can be used anywhere you need column+gutter math.
* `push`, `pull`, `pre`, `post`, and `squish` add margin left/right shortcuts.
Semantics:

Changed API:
We re-arranged the code
in order to make the syntax simpler and more consistent:

* `$total-cols` => `$total-columns`
* `$col-width` => `$column-width`
* `$side-gutter-width` => `$grid-padding`
* `+un-column` & `+reset-column` => `+reset-columns`
* `+columns` => `+span-columns`

Removed:
* `$total-cols` is now `$total-columns`.
* `$col-width` is now `$column-width`.
* `$side-gutter-width` is now `$grid-padding`
and gets applied directly to the grid container.
* `un-column` & `reset-column` mixins have merged into `reset-columns`.
* `columns` has been renamed `span-columns` to resolve the conflict with CSS3 columns.
See other improvements to span-columns below.

* `alpha` is no longer needed.
* `+omega` no longer accepts the `$context` argument.
* `full` can be replaced by a simple `clear: both;` when needed.
* `side-gutter()` is no longer needed. Use `$grid-padding` instead.
We also removed several bothersome requirements:

Other:
* The `alpha` mixin is no longer needed. Ever.
* The `omega` no longer takes a `$context` argument.
* `full` has been removed entirely.
Elements will be full-width by default.
You can add `clear: both;` back in as needed.
* `side-gutter()` is no longer needed.
You can use the `$grid-padding` setting directly.

* Fix bug in susy-background-grid for fluid sites.
* Fix minor bug with repeated 'display' properties.
* Lower Compass dependency to 0.12.2
* Add Sass dependency at 3.2.0.alpha.247
Upgrade:

### Upgrade:
That's all you need in order to upgrade from Susy 0.9.

1. Uninstall `compass-susy-plugin` and install `susy` in it's place.
2. Find and replace the 5 simple "Changed API's" listed above.
3. Remove the `$context` argument from all `omega` mixins.
4. Remove any mention of `alpha` and `full` in your code.
* Replace `full` with `clear: both;` where necessary.
5. Remove any mention of `side-gutter()`.
* This may require some refactoring, depending on your uses.
6. [Optional] Any time 'columns' and 'omega' are declared in the same block,
they can now be joined together. `@include columns(3); @include omega();`
can become `@include columns(3 omega)`.
1. Uninstall and re-install the gem.
2. Find and replace the semantic changes listed above.

You're done! Stop worrying about all that "nested vs. root" bullshit,
and start playing with the new toys!

If you use the `$from` directional arguments
directly in the `span-columns` mixin,
there may be one more change to make.
See below:

New Features:

* `span-columns` supports new features:
- "omega" can be applied directly through the `$columns` argument.
- Internal padding can be added through the `$padding` argument.
- This pushes the `$from` argument from third position into fourth.
* `at-breakpoint` allows you to change layouts at media breakpoints.
* `container` accepts multiple media-layout combinations as a shortcut.
* `layout` allows you to use a different layout at any time.
* `with-grid-settings` allows you to change any or all grid settings.
* `set-container-width` does what it says, without the other container code.
* `$breakpoint-media-output`, `$breakpoint-ie-output`, and `$breakpoint-raw-output`
settings help manage the different outputs from `at-breakpoint`
when you have IE-overrides living in a file of their own.
* `border-box-sizing` will apply the popular `* { box-sizing: border-box }`
universal box-model fix, as well as changing the Susy `$border-box-model` setting for you,
so Susy knows to adjust some math.
* The `space()` function can be used anywhere you need column+gutter math.
* `push`, `pull`, `pre`, `post`, and `squish` mixins help manage margins.
* use the `nth-omega` mixin to set omega on any nth-child, nth-of-type,
first, last, or only element.
* `remove-omega` and `remove-nth-omega` will remove
the omega-specific styles from an element.
* `$container-width` will override the width of your container
with any arbitrary length.
* `$container-style` will override the type of grid container
(magic, fluid, fixed, static, etc) to use.

v0.9 [Apr 25 2011]
------------------

Expand Down
2 changes: 1 addition & 1 deletion SASS.lrplugin/lib/susy/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2011, Eric Meyer
Copyright (c) 2012, Eric Meyer
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion SASS.lrplugin/lib/susy/Manifest
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CHANGELOG.mkdn
LICENSE.txt
Manifest
README.mkdn
README.md
Rakefile
VERSION
lib/susy.rb
Expand Down
121 changes: 121 additions & 0 deletions SASS.lrplugin/lib/susy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Susy [a Compass plugin]

Susy is a semantic CSS grid system with a responsive twist.

The web is a responsive place,
from your lithe & lively development process
to your end user's super-tablet-multi-magic-lap-phone.
You need grids that are powerful, but custom;
reliable, but responsive.

Susy grids are fluid on the inside,
ready to respond at any moment,
but contained in the candy shell of your choice,
so they respond how and when and where you want them to.

This isn't another one-size-fits-all grid framework
that will make your sites look identical
and litter your markup with meaningless "col2of5" jargon.
We don't design your site or write your markup,
we just do the math and get out of your way.

## Resources
- [Website](http://susy.oddbird.net)
- [Changelog](https://github.com/ericam/susy/blob/master/CHANGELOG.mkdn)
- [Tutorial](http://susy.oddbird.net/guides/getting-started/)
- [Reference](http://susy.oddbird.net/guides/reference/)
- [Sites using Susy](http://susy.oddbird.net/sites-using-susy/)
- [Twitter @CompassSusy](http://twitter.com/compasssusy/)

## Contributing

We love contributions,
both as ideas and pull requests.
The core of Susy is all in the `/sass/` directory.

Once you make changes,
you can test them by building the gem
and installing it somewhere to test.
We also have unit tests that you can run.

### Building the gem

You'll need Rake and Echoe installed:

```bash
# command line
gem install rake
gem install echoe
```

It might be helpful to bump the version number in `VERSION`,
but any changes you make there
should not be committed.

Then you can build:

```bash
# command line
rake build
```

Your new gem will appear in
a folder called `pkg`.
You can install it for testing
directly from there.

```bash
# command line
gem install <path-to-file>
```

### Building the docs

If you are adding features
or changing how a current feature works,
your changes should be documented.
Or you might be helping us maintain the docs.
In either case,
you'll need to run the docs dev server
in order to see your changes.

In the `docs` folder:

```bash
# command line
gem install bundler
bundle install
```

The site is built with
[middleman](http://middlemanapp.com/).
To run the development server:

```bash
# command line
middleman
```

The server should now be running at `localhost:4567`.

Make any changes you need
under the `source` directory,
then commit your changes
and submit a pull request when you are done!

### Tests

The tests we have are very basic at this point.
Simply go into the `test` directory
(with the latest Sass and Compass gems installed)
and run `compass compile --force`.

There should be no changes.
If there are changes,
go back and find what caused the change.
If the change was intentional,
simply commit the changed test files.
If it was not intentional,
go back and find what caused the problem.

Use `git diff` to see the changes.
37 changes: 0 additions & 37 deletions SASS.lrplugin/lib/susy/README.mkdn

This file was deleted.

2 changes: 1 addition & 1 deletion SASS.lrplugin/lib/susy/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ begin
p.url = "http://susy.oddbird.net/"
p.author = "Eric Meyer"
p.email = "[email protected]"
p.dependencies = ["compass >=0.12.2", "sass >=3.2.0.alpha.247"]
p.dependencies = ["compass >=0.12.2", "sass >=3.2.0"]
end

rescue LoadError => boom
Expand Down
2 changes: 1 addition & 1 deletion SASS.lrplugin/lib/susy/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.rc.2
1.0
Loading