mini.css/README.md

35 lines
1.6 KiB
Markdown
Raw Normal View History

2016-12-20 11:44:28 +00:00
# mini.css v2.0.0
## A minimal, responsive, style-agnostic CSS toolkit
2016-09-06 09:25:18 +00:00
2016-12-20 12:07:05 +00:00
![Logo](/docs/page_thumb.PNG)
2016-08-22 11:28:06 +00:00
2016-12-20 11:44:28 +00:00
**mini.css** is a tiny CSS toolkit (under 7KB gzipped) that works well on most modern browsers and devices and allows you to customize it quickly and easily. It's written in Sass and tries to make use of HTML5 semantics and modern patterns to deal with common web design problems. You can learn all about using it, its modules and components, as well as see a live demo [here](https://chalarangelo.github.io/mini.css/).
2016-09-21 10:38:55 +00:00
## Setup
2016-08-22 11:28:06 +00:00
2016-12-20 11:44:28 +00:00
**mini.css** is available in both NPM and Bower:
2016-09-21 12:57:26 +00:00
npm install mini.css
2016-12-20 11:44:28 +00:00
bower install mini.css
2016-09-21 12:57:26 +00:00
2016-09-05 16:30:04 +00:00
2016-12-20 11:44:28 +00:00
To try out **mini.css** using the default flavor, copy and paste the following code inside your HTML page's `<head>` tag:
2016-10-11 07:07:22 +00:00
2016-12-20 11:44:28 +00:00
<link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/version/dist/mini-default.min.css">
2016-09-21 10:38:55 +00:00
2016-12-20 11:44:28 +00:00
Replace `version` with a release tag (`v2.0.0` or later) from the [Releases page](https://github.com/Chalarangelo/mini.css/releases).
Alternatively, you can use one of the other [flavors](https://chalarangelo.github.io/mini.css/flavors.html). Simply replace the final part of the URL with the flavor's CSS file (minified or not) and you're good to go!
2016-09-21 10:38:55 +00:00
## Customization
2016-12-20 11:44:28 +00:00
If you want to develop your own flavor or tweak an existing one, head over to the [Customization page](https://chalarangelo.github.io/mini.css/customization.html) to get started.
## Contributing
2016-09-21 10:38:55 +00:00
2016-12-20 11:44:28 +00:00
If you develop a flavor or module, please submit a pull request.
2016-09-21 10:38:55 +00:00
## License
The project is licensed under the [MIT License](https://github.com/Chalarangelo/mini.css/blob/master/LICENSE).