Browse Source

Docs - copy revisions

pull/14/head
David DeSandro 14 years ago
parent
commit
cda1db39ac
  1. 37
      README.mdown
  2. 29
      _posts/docs/2010-12-01-introduction.mdown
  3. 4
      _posts/docs/2010-12-04-methods.mdown
  4. 6
      _posts/docs/2010-12-06-filtering.mdown
  5. 2
      _posts/docs/2010-12-07-sorting.mdown
  6. 2
      _posts/docs/2010-12-09-animating.mdown
  7. 2
      _posts/docs/2010-12-11-troubleshooting.mdown
  8. 6
      css/style.css

37
README.mdown

@ -1,25 +1,36 @@
Isotope
========
**An exquisite filtering, sorting, layout jQuery plugin.**
**An exquisite jQuery plugin for magical layouts. Enables filtering, sorting, and dynamic layouts.**
Requires jQuery versions 1.4.3 and up.
This package has all the documentation and demos to get you started.
Features
--------
+ Developed for progressive enhancement. Positioning and animation take advantage of CSS3 transforms and transitions when available.
+ Dynamic layouts
+ Sort elements according to any attribute, text, or anything
+ Easy filtering
+ Animated interaction for dynamic layout
+ Develop your own layout with the plugin's integrated layout API
View this project live at ...
Licensing
---------
Use on commercial (for-profit) sites requires one-time license fee per developer-seat. Purchase yours at [metafizzy.net/licensing](http://metafizzy.net/licensing).
**Commercial use requires purchase of one-time license fee per developer seat.** Commercial use includes any application that makes you money. This includes portfolio sites and premium templates. Commercial licenses may be purchased at [metafizzy.co](http://metafizzy.co).
Use in non-commercial and personal applications is free.
Viewing this project locally
----------------------------
### Via Jekyll
The documentation and example pages are generated using [Jekyll](https://github.com/mojombo/jekyll/wiki). With Jekyll installed, you can pull or fork this repo and then run from Terminal:
$ git pull git@github.com:desandro/isotope.git
$ cd isotope/
$ jekyll --server --auto
And then view the live site at [localhost:4000](http://localhost:4000)
### Via download
You can download a zip of all the flat HTML files from [Downloads](http://github.com/desandro/isotope/downloads).
Free for personal (non-commercial) use.
* * *
Copyright (c) 2011 David DeSandro / Metafizzy LLC

29
_posts/docs/2010-12-01-introduction.mdown

@ -11,20 +11,35 @@ related: etc
## Features
+ **Layout modes**: Intelligent, dynamic layouts that can't be achieved with CSS alone.
+ **Filtering**: Hide and reveal item elements easily with jQuery selectors.
+ **Sorting**: Re-order item elements with sorting. Sorting data can be extracted from just about anything.
+ **Interoperabilty**: features can be utilized together for a cohesive experience.
+ **Progressive enhancement**: Isotope's engaging animations take advantage of the best CSS transition and transform features when available, but also fall back to Javascript animation for lesser browsers.
+ [**Layout modes**](layout-modes.html): Intelligent, dynamic layouts that can't be achieved with CSS alone.
+ [**Filtering**](filtering.html): Hide and reveal item elements easily with jQuery selectors.
+ [**Sorting**](sorting.html): Re-order item elements with sorting. Sorting data can be extracted from just about anything.
+ **Interoperability**: features can be utilized together for a cohesive experience.
+ **Progressive enhancement**: Isotope's [animation engine](animating.html) takes advantage of CSS transitions and transforms when available, but will also fall back to Javascript animation for lesser browsers.
## License
<p id="commercial">
<strong>Commercial use requires purchase of one-time license fee per developer seat.</strong> Commercial use includes any application that makes you money. This includes portfolio sites and premium templates. Commercial licenses may be purchased at <a href="http://metafizzy.co">metafizzy.co</a>.
<strong>Commercial use requires purchase of one-time license fee per developer seat.</strong> Commercial use includes any application that makes you money &mdash; portfolio sites, premium templates, etc. Commercial licenses may be purchased at <a href="http://metafizzy.co">metafizzy.co</a>.
</p>
Use in non-commercial and personal applications is free.
<p class="as-is">
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</p>
## Getting started
Isotope requires jQuery 1.4.3 and greater.
@ -60,7 +75,7 @@ There are a number of [options](options.html) you can specify. Within the optio
## Code repository
%% This project lives on GitHub at.... %%
This project lives on GitHub at [github.com/desandro/isotope](http://github.com/desandro/isotope). There you can grab the latest code and download this entire project.
## Acknowledgments

4
_posts/docs/2010-12-04-methods.mdown

@ -68,7 +68,9 @@ Appends elements to container, adds items to via `addItems` method, and then tri
{% endhighlight %}
Arranges new elements to the end of the layout.
Positions specified elements in layout.
`layout` will only position specified elements, and those elements will be positioned at the end of layout. Whereas `reLayout` will position all elements in the Isotope widget.
## option

6
_posts/docs/2010-12-06-filtering.mdown

@ -42,7 +42,7 @@ $('#demo').isotope({ filter: '.metal' });
Filtering selectors work just as expected. `.alkali, alkaline-earth` with show both `.alkali` AND ` .alkaline-earth` items, and hide all others. `.metal:not(.transition)` will show `.metal` item elements that are not `.transition`.
## Buttons
## Creating interactive buttons
Let's use a basic list for our buttons
@ -59,7 +59,7 @@ Let's use a basic list for our buttons
{% endhighlight %}
Here we set the filter for each link with a `data-filter` attribute. In our jQuery script, whenever a link is clicked, we'll use this attribute as the filter secltor.
Here we set the filter for each link with a `data-filter` attribute. In our jQuery script, whenever a link is clicked, we'll use this attribute as the filter selector.
{% highlight javascript %}
@ -90,4 +90,4 @@ If you choose to use the filtering functionality, add the following CSS to your
{% endhighlight %}
These styles ensure that hidden items will not interfer with interactions.
These styles ensure that hidden items will not interfere with interactions.

2
_posts/docs/2010-12-07-sorting.mdown

@ -119,7 +119,7 @@ $('#demo').isotope({
{% endhighlight %}
## Buttons
## Creating interactive buttons
We can use a simple list for our buttons.

2
_posts/docs/2010-12-09-animating.mdown

@ -7,7 +7,7 @@ related: animating
---
Isotope was developed to take advantage of the best browser features available.
Isotope was developed to take advantage of the best browser features available. For animations, you can use CSS3 transitions and transforms in capable browsers. Isotope provides Javascript animation fall back for lesser browsers.
## animationEngine

2
_posts/docs/2010-12-11-troubleshooting.mdown

@ -44,6 +44,4 @@ Both Typekit and Google WebFont Loader provide font events to control scripts ba
Additionally, you can use the `$(window).load()` pattern above to wait for all content, including @font-face fonts, to load before initializing Isotope.
## Opera

6
css/style.css

@ -489,6 +489,12 @@ h3#options {
font-weight: 300;
}
/* as-is from MIT */
.doc .as-is {
font-size: 95%;
}
/* Commercial license blurb */
.doc #commercial {

Loading…
Cancel
Save