pure/README.md

152 lines
3.9 KiB
Markdown
Raw Normal View History

2013-05-16 17:01:32 +00:00
Pure
====
2013-05-20 17:23:59 +00:00
2013-05-22 18:17:43 +00:00
[![Pure](http://f.cl.ly/items/2y0M0E2Q3a2H0z1N1Y19/pure-banner.png)][Pure]
2013-05-20 17:23:59 +00:00
A set of small, responsive CSS modules that you can use in every web project.
2013-05-22 12:06:01 +00:00
[http://purecss.io/][Pure]
2013-05-20 17:23:59 +00:00
[![Build Status](https://travis-ci.org/yui/pure.png?branch=master)][Build Status]
2013-05-22 12:06:01 +00:00
**Use From the CDN:**
2013-05-20 17:25:26 +00:00
```html
2013-07-18 02:16:03 +00:00
<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.2.1/pure-min.css">
2013-05-20 17:25:26 +00:00
```
2013-05-20 17:23:59 +00:00
Alternatively, you can [customize how you use Pure][customize].
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
[Pure]: http://purecss.io/
[Build Status]: https://travis-ci.org/yui/pure
[customize]: http://purecss.io/customize/
2013-05-22 12:06:01 +00:00
Features
--------
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
Pure is meant to be a starting point for every website or web app. We take care
of all the CSS work that every site needs, without making it look cookie-cutter:
2013-05-20 17:23:59 +00:00
* A responsive grid that can be customized to your needs.
2013-05-22 12:06:01 +00:00
* A solid base built on [Normalize.css][] to fix cross-browser compatibility
issues.
* Consistently styled buttons that work with `<a>` and `<button>` elements.
2013-05-22 12:06:01 +00:00
* Styles for vertical and horizontal menus, including support for dropdown
menus.
* Useful form alignments that look great on all screen sizes.
* Various common table styles.
* An extremely minimalist look that is super-easy to customize.
* Responsive by default, with a non-responsive option.
* Easy one-click customization with the [Skin Builder][].
2013-05-22 12:06:01 +00:00
* Extremely small file size: **4.3KB minified + gzip**.
2013-05-22 12:06:01 +00:00
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
[Normalize.css]: http://necolas.github.io/normalize.css/
[Skin Builder]: http://yui.github.io/skinbuilder/?mode=pure
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
Get Started
-----------
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
To get started using Pure, go to the [Pure CSS website][Pure]. The website has
extensive documentation and examples necessary to get you started using Pure.
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
You can include the Pure CSS file in your project by fetching it from Yahoo's
CDN:
2013-05-20 17:23:59 +00:00
2013-05-20 17:25:26 +00:00
```html
2013-07-18 02:16:03 +00:00
<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.2.1/pure-min.css">
2013-05-20 17:25:26 +00:00
```
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
Build From Source
-----------------
Optionally, you can build Pure from its source on Github. To do this, you'll
need to have Node.js and npm installed. We use [Grunt][] to build Pure.
2013-05-20 17:23:59 +00:00
```shell
$ git clone git@github.com:yui/pure.git
$ cd pure
$ npm install
$ grunt
2013-05-20 17:23:59 +00:00
```
### Build Files
2013-05-22 12:06:01 +00:00
Now, all Pure CSS files should be built into the `pure/build/` directory. All
files that are in this build directory are also available on the CDN. The naming
conventions of the files in the `build/` directory follow these rules:
* `[module]-core.css`: The minimal set of styles, ususally structural, that
provide the base on which the rest of the module's styles build.
2013-05-22 12:06:01 +00:00
* `[module]-nr.css`: Rollup of `[module]-core.css` + `[module].css` +
`[module]-[feature].css` from the `src/[module]/` dir. This is the
non-responsive version of a module.
2013-05-22 12:06:01 +00:00
* `[module].css`: Rollup of `[module]-nr.css` + `[module]-r.css` from the
`build/` dir. This is the responsive version of a module.
2013-05-22 12:06:01 +00:00
* `*-min.css`: A minified file version of the files of the same name.
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
* `pure-min.css`: A rollup of all `[module]-min.css` files in the `build/` dir.
This is a responsive roll-up of everything.
2013-05-22 12:06:01 +00:00
* `pure-nr-min.css`: A Rollup of all modules without @media queries. This is a
non-responsive roll-up of everything.
2013-05-20 17:23:59 +00:00
[Grunt]: http://gruntjs.com/
Browser Support and Testing
---------------------------
Pure is tested and works in:
* IE 7+
* Latest Stable: Firefox, Chrome, Safari
* iOS 6.x
* Android 4.x
Docs and Website
----------------
2013-05-20 17:23:59 +00:00
[Pure's website][Pure] is also open source, so please open any issues or pull
requests for the docs and website over at the [`pure-site`][pure-site]
repository.
2013-05-20 17:23:59 +00:00
2013-05-22 12:06:01 +00:00
[pure-site]: https://github.com/yui/pure-site
Contributing
------------
See the [CONTRIBUTING file][] for information on how to contribute to Pure.
[CONTRIBUTING file]: https://github.com/yui/pure/blob/master/CONTRIBUTING.md
2013-05-22 12:06:01 +00:00
License
-------
This software is free to use under the Yahoo! Inc. BSD license.
2013-05-22 12:06:01 +00:00
See the [LICENSE file][] for license text and copyright information.
2013-05-22 12:06:01 +00:00
[LICENSE file]: https://github.com/yui/pure/blob/master/LICENSE.md