Skip to content

Commit e194c98

Browse files
committed
Prepare documentation for 5.0.0 release
1 parent e937926 commit e194c98

File tree

4 files changed

+93
-16
lines changed

4 files changed

+93
-16
lines changed

README-UZ.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# PostCSS Sort Media Queries
2+
3+
[PostCSS]: https://github.com/postcss/postcss
4+
[ci-img]: https://travis-ci.org/solversgroup/postcss-sort-media-queries.svg
5+
[ci]: https://travis-ci.org/solversgroup/postcss-sort-media-queries
6+
[MIT]: https://github.com/solversgroup/postcss-sort-media-queries/blob/master/LICENSE
7+
[official docs]: https://github.com/postcss/postcss#usage
8+
[Releases history]: https://github.com/solversgroup/postcss-sort-media-queries/blob/master/CHANGELOG.md
9+
10+
[![npm](https://img.shields.io/npm/v/postcss-sort-media-queries.svg)](https://www.npmjs.com/package/postcss-sort-media-queries) [![Build Status][ci-img]][ci]
11+
[![npm](https://img.shields.io/npm/dt/postcss-sort-media-queries.svg)](https://www.npmjs.com/package/postcss-sort-media-queries)
12+
13+
<img src="logo.svg?sanitize=true" align="right" title="PostCSS sort media queries logotype" width="100" height="100">
14+
15+
🌏 [**English**](README.md)**O'zbek**

README.md

+41-11
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,30 @@
1010
[![npm](https://img.shields.io/npm/v/postcss-sort-media-queries.svg)](https://www.npmjs.com/package/postcss-sort-media-queries) [![Build Status][ci-img]][ci]
1111
[![npm](https://img.shields.io/npm/dt/postcss-sort-media-queries.svg)](https://www.npmjs.com/package/postcss-sort-media-queries)
1212

13-
[PostCSS] plugin for combine and sort CSS media queries with **mobile first** or **desktop first** methods.
13+
<img src="logo.svg?sanitize=true" align="right" title="PostCSS sort media queries logotype" width="100" height="100">
1414

15-
> **Combine** same media queries into one - is a unexpected side effect for this plugin 🧬
15+
🌏 **English**[**O'zbek**](README-UZ.md)
16+
17+
[PostCSS] plugin for sorting and combining CSS media queries with **mobile first** / **desktop first** methodologies.
18+
19+
> From 5.0.0 plugin support [Media Feature Types: “range”](https://www.w3.org/TR/mediaqueries-4/#mq-ranges)
20+
21+
## Table of Contents
22+
23+
- [Online demo](#online-demo)
24+
- [Examples](#examples)
25+
- [Mobile first sorting](#mobile-first-sorting)
26+
- [Desktop first sorting](#desktop-first-sorting)
27+
- [Install](#install)
28+
- [Usage](#usage)
29+
- [Options](#options)
30+
- [sort](#sort)
31+
- [Custom sort function](#custom-sort-function)
32+
- [Sort configuration](#sort-configuration)
33+
- [Changelog](#changelog)
34+
- [License](#license)
35+
- [Other PostCSS plugins](#other-postcss-plugins)
36+
- [Thanks 💪](#thanks)
1637

1738
## Online demo
1839

@@ -22,8 +43,9 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
2243

2344
### Mobile first sorting
2445

46+
**before**
47+
2548
```css
26-
/* before */
2749
@media screen and (max-width: 640px) {
2850
.head { color: #cfcfcf }
2951
}
@@ -42,8 +64,11 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
4264
@media screen and (max-width: 640px) {
4365
.footer { color: #cfcfcf }
4466
}
67+
```
4568

46-
/* after */
69+
**after**
70+
71+
```css
4772
@media screen and (min-width: 640px) {
4873
.mobile-first { color: #cfcfcf }
4974
}
@@ -54,6 +79,7 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
5479
.footer { color: #cfcfcf }
5580
}
5681
@media screen and (max-width: 640px) {
82+
/* combined */
5783
.head { color: #cfcfcf }
5884
.main { color: #cfcfcf }
5985
.footer { color: #cfcfcf }
@@ -62,8 +88,8 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
6288

6389
### Desktop first sorting
6490

91+
**before**
6592
```css
66-
/* before */
6793
@media screen and (max-width: 640px) {
6894
.header { color: #cdcdcd }
6995
}
@@ -82,12 +108,16 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
82108
@media screen and (max-width: 640px) {
83109
.footer { color: #cdcdcd }
84110
}
111+
```
85112

86-
/* after */
113+
**after**
114+
115+
```css
87116
@media screen and (max-width: 760px) {
88117
.footer { color: #cdcdcd }
89118
}
90119
@media screen and (max-width: 640px) {
120+
/* combined */
91121
.header { color: #cdcdcd }
92122
.main { color: #cdcdcd }
93123
.footer { color: #cdcdcd }
@@ -100,15 +130,15 @@ And here is the [online demo](https://postcss-sort-media-queries.github.io)
100130
}
101131
```
102132

103-
## Getting Started
133+
## Install
104134

105135
First thing's, install the module:
106136

107137
```
108138
npm install postcss postcss-sort-media-queries --save-dev
109139
```
110140

111-
## 🍳 Usage
141+
## Usage
112142

113143
Check you project for existed PostCSS config: `postcss.config.js`
114144
in the project root, `"postcss"` section in `package.json`
@@ -133,7 +163,7 @@ module.exports = {
133163
If you do not use PostCSS, add it according to [official docs]
134164
and set this plugin in settings.
135165

136-
## 🍰 Options
166+
## Options
137167

138168
> Sorting works based on [dutchenkoOleg/sort-css-media-queries](https://github.com/dutchenkoOleg/sort-css-media-queries) function.
139169
@@ -210,10 +240,10 @@ See [Releases history]
210240

211241
- [`postcss-momentum-scrolling`](https://github.com/solversgroup/postcss-momentum-scrolling) - plugin for adding **momentum** style scrolling behavior (`-webkit-overflow-scrolling:touch`) for elements with overflow (scroll, auto) on iOS
212242

213-
## Thanks 💪
243+
## Thanks
214244

215245
- Andrey Sitnik [@ai](https://github.com/ai)
246+
- Oleh Dutchenko [@dutchenkoOleg](https://github.com/dutchenkoOleg)
216247
- Jakub Caban [@Lustmored](https://github.com/Lustmored)
217248
- Dmytro Symonov [@Kassaila](https://github.com/Kassaila)
218249
- Kai Falkowski [@SassNinja](https://github.com/SassNinja)
219-
- Олег Дутченко [@dutchenkoOleg](https://github.com/dutchenkoOleg)

logo.svg

+25
Loading

package.json

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
{
22
"name": "postcss-sort-media-queries",
33
"version": "4.3.0",
4-
"description": "PostCSS plugin for combine and sort CSS media queries with mobile first or desktop first methods.",
4+
"description": "PostCSS plugin for sorting and combining CSS media queries with mobile first / **desktop first methodologies",
55
"keywords": [
66
"postcss",
7-
"css",
87
"postcss-plugin",
8+
"css",
9+
"css-optimizations",
910
"sort",
10-
"media-queries",
11+
"mobile-first",
12+
"desktop-first",
1113
"mediaquery",
14+
"media-queries",
1215
"mq",
13-
"optimization"
16+
"responsive-css",
17+
"combine-media-query",
18+
"sort-media-query",
19+
"css-mqpacker",
20+
"node-css-mqpacker"
1421
],
15-
"author": "Yunus Gaziev <[email protected]>",
22+
"author": "Yunus Gaziyev <[email protected]>",
1623
"license": "MIT",
1724
"repository": {
1825
"type": "git",

0 commit comments

Comments
 (0)