Skip to content

Commit 645fbf7

Browse files
committed
docs: update README
1 parent eafbb6a commit 645fbf7

File tree

2 files changed

+122
-119
lines changed

2 files changed

+122
-119
lines changed

README.md

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -23,40 +23,40 @@ Flexbox Grid Mixins documentation: [https://thingsym.github.io/flexbox-grid-mixi
2323

2424
### Sass
2525

26-
#### LibSass
26+
#### Dart Sass
2727

2828
```
29-
@import 'node_modules/flexbox-grid-mixins/sass/flexbox-grid-mixins';
29+
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
3030
3131
$default-grid-gutter: 2%;
3232
3333
.grid {
34-
@include grid($gutter: $default-grid-gutter);
34+
@include flexbox-grid-mixins.grid($gutter: $default-grid-gutter);
3535
3636
> .grid__col-3 {
37-
@include grid-col($col: 3, $gutter: $default-grid-gutter);
37+
@include flexbox-grid-mixins.grid-col($col: 3, $gutter: $default-grid-gutter);
3838
}
3939
> .grid__col-9 {
40-
@include grid-col($col: 9, $gutter: $default-grid-gutter);
40+
@include flexbox-grid-mixins.grid-col($col: 9, $gutter: $default-grid-gutter);
4141
}
4242
}
4343
```
4444

45-
#### Dart Sass
45+
#### LibSass
4646

4747
```
48-
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
48+
@import 'node_modules/flexbox-grid-mixins/sass/flexbox-grid-mixins';
4949
5050
$default-grid-gutter: 2%;
5151
5252
.grid {
53-
@include flexbox-grid-mixins.grid($gutter: $default-grid-gutter);
53+
@include grid($gutter: $default-grid-gutter);
5454
5555
> .grid__col-3 {
56-
@include flexbox-grid-mixins.grid-col($col: 3, $gutter: $default-grid-gutter);
56+
@include grid-col($col: 3, $gutter: $default-grid-gutter);
5757
}
5858
> .grid__col-9 {
59-
@include flexbox-grid-mixins.grid-col($col: 9, $gutter: $default-grid-gutter);
59+
@include grid-col($col: 9, $gutter: $default-grid-gutter);
6060
}
6161
}
6262
```
@@ -113,73 +113,73 @@ $ yarn add flexbox-grid-mixins --dev
113113

114114
### Manual Install
115115

116-
Include `sass/\_flexbox-grid-mixins.scss` or `dart-sass/\_flexbox-grid-mixins.scss` in the appropriate location in your project.
116+
Include `dart-sass/\_flexbox-grid-mixins.scss` or `sass/\_flexbox-grid-mixins.scss` in the appropriate location in your project.
117117

118-
## Getting Started using LibSass
119-
120-
Note: [LibSass is Deprecated](https://sass-lang.com/blog/libsass-is-deprecated). See [Future Plans](https://sass-lang.com/blog/the-module-system-is-launched#future-plans).
118+
## Getting Started using Dart Sass
121119

122120
### 1. Import Flexbox Grid Mixins in Sass/SCSS file
123121

124122
```
125-
@import 'flexbox-grid-mixins';
123+
@use 'flexbox-grid-mixins';
126124
```
127125

128126
Example : import from node_modules
129127

130128
```
131-
@import 'node_modules/flexbox-grid-mixins/sass/flexbox-grid-mixins';
129+
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
132130
```
133131

134132
### 2. Define the grid container
135133

136134
```
137135
.grid {
138-
@include grid();
136+
@include flexbox-grid-mixins.grid();
139137
}
140138
```
141139

142140
### 3. Generate the grid columns
143141

144142
```
145143
.grid__col-3 {
146-
@include grid-col(3);
144+
@include flexbox-grid-mixins.grid-col(3);
147145
}
148146
.grid__col-9 {
149-
@include grid-col(9);
147+
@include flexbox-grid-mixins.grid-col(9);
150148
}
151149
```
152150

153-
## Getting Started using Dart Sass
151+
## Getting Started using LibSass
152+
153+
Note: [LibSass is Deprecated](https://sass-lang.com/blog/libsass-is-deprecated). See [Future Plans](https://sass-lang.com/blog/the-module-system-is-launched#future-plans).
154154

155155
### 1. Import Flexbox Grid Mixins in Sass/SCSS file
156156

157157
```
158-
@use 'flexbox-grid-mixins';
158+
@import 'flexbox-grid-mixins';
159159
```
160160

161161
Example : import from node_modules
162162

163163
```
164-
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
164+
@import 'node_modules/flexbox-grid-mixins/sass/flexbox-grid-mixins';
165165
```
166166

167167
### 2. Define the grid container
168168

169169
```
170170
.grid {
171-
@include flexbox-grid-mixins.grid();
171+
@include grid();
172172
}
173173
```
174174

175175
### 3. Generate the grid columns
176176

177177
```
178178
.grid__col-3 {
179-
@include flexbox-grid-mixins.grid-col(3);
179+
@include grid-col(3);
180180
}
181181
.grid__col-9 {
182-
@include flexbox-grid-mixins.grid-col(9);
182+
@include grid-col(9);
183183
}
184184
```
185185

@@ -196,28 +196,31 @@ See Flexbox Grid Mixins documentation: [http://thingsym.github.io/flexbox-grid-m
196196
* [Basic Example](http://thingsym.github.io/flexbox-grid-mixins/#Basic-Example)
197197
* [Grid System Example](http://thingsym.github.io/flexbox-grid-mixins/#Grid-System-Example)
198198

199-
### LibSass
200-
201-
* [Flexbox Grid Mixins Example](http://thingsym.github.io/flexbox-grid-mixins/example/example.html)
202-
* [Holy Grail Layout - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/holy-grail-layout.html)
203-
* [Responsive web design - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/responsive.html)
204-
* [Unit-Set Grid (Experimental stage)](http://thingsym.github.io/flexbox-grid-mixins/example/unit-set.html)
205-
* [Box Sizing using Default Values](http://thingsym.github.io/flexbox-grid-mixins/example/box-sizing.html)
206-
* [Stack](http://thingsym.github.io/flexbox-grid-mixins/example/stack.html)
207-
* [Grid Type](http://thingsym.github.io/flexbox-grid-mixins/example/grid-type.html)
208-
* [Testing Stick Out Grid](http://thingsym.github.io/flexbox-grid-mixins/example/test-stick-out.html)
209-
210-
211199
### Dart Sass
212200

213201
* [Flexbox Grid Mixins Example](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/example.html)
214202
* [Holy Grail Layout - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/holy-grail-layout.html)
215203
* [Responsive web design - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/responsive.html)
216-
* [Unit-Set Grid (Experimental stage)](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/unit-set.html)
204+
* [Gap (grid-gap) css property](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/gap.html)
205+
* [Auto margin](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/auto-margin.html)
217206
* [Box Sizing using Default Values](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/box-sizing.html)
218207
* [Stack](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/stack.html)
219208
* [Grid Type](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/grid-type.html)
220-
* [Testing Stick Out Grid](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/test-stick-out.html)
209+
* [Unit-Set Grid (Experimental stage)](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/unit-set.html)
210+
* [Test] [Stick Out Grid](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/test-stick-out.html)
211+
212+
### LibSass
213+
214+
* [Flexbox Grid Mixins Example](http://thingsym.github.io/flexbox-grid-mixins/example/example.html)
215+
* [Holy Grail Layout - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/holy-grail-layout.html)
216+
* [Responsive web design - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/responsive.html)
217+
* [Gap (grid-gap) css property](http://thingsym.github.io/flexbox-grid-mixins/example/gap.html)
218+
* [Auto margin](http://thingsym.github.io/flexbox-grid-mixins/example/auto-margin.html)
219+
* [Box Sizing using Default Values](http://thingsym.github.io/flexbox-grid-mixins/example/box-sizing.html)
220+
* [Stack](http://thingsym.github.io/flexbox-grid-mixins/example/stack.html)
221+
* [Grid Type](http://thingsym.github.io/flexbox-grid-mixins/example/grid-type.html)
222+
* [Unit-Set Grid (Experimental stage)](http://thingsym.github.io/flexbox-grid-mixins/example/unit-set.html)
223+
* [Test] [Stick Out Grid](http://thingsym.github.io/flexbox-grid-mixins/example/test-stick-out.html)
221224

222225
## Package manager
223226

@@ -313,4 +316,4 @@ Licensed under the MIT License.
313316

314317
[thingsym](https://github.com/thingsym)
315318

316-
Copyright (c) 2016-2020 thingsym
319+
Copyright (c) 2016-2022 thingsym

0 commit comments

Comments
 (0)