Skip to content

Commit 76bca5c

Browse files
committed
docs: add dart sass contents
1 parent 70bd04d commit 76bca5c

File tree

2 files changed

+216
-28
lines changed

2 files changed

+216
-28
lines changed

README.md

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

2424
### Sass
2525

26+
#### LibSass
27+
2628
```
2729
@import 'node_modules/flexbox-grid-mixins/sass/flexbox-grid-mixins';
2830
@@ -40,6 +42,25 @@ $default-grid-gutter: 2%;
4042
}
4143
```
4244

45+
#### Dart Sass
46+
47+
```
48+
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
49+
50+
$default-grid-gutter: 2%;
51+
52+
.grid {
53+
@include flexbox-grid-mixins.grid($gutter: $default-grid-gutter);
54+
55+
> .grid__col-3 {
56+
@include flexbox-grid-mixins.grid-col($col: 3, $gutter: $default-grid-gutter);
57+
}
58+
> .grid__col-9 {
59+
@include flexbox-grid-mixins.grid-col($col: 9, $gutter: $default-grid-gutter);
60+
}
61+
}
62+
```
63+
4364
### CSS
4465

4566
```
@@ -92,9 +113,11 @@ $ yarn add flexbox-grid-mixins --dev
92113

93114
### Manual Install
94115

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

97-
## Getting Started
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).
98121

99122
### 1. Import Flexbox Grid Mixins in Sass/SCSS file
100123

@@ -127,6 +150,39 @@ Example : import form node_modules
127150
}
128151
```
129152

153+
## Getting Started using Dart Sass
154+
155+
### 1. Import Flexbox Grid Mixins in Sass/SCSS file
156+
157+
```
158+
@use 'flexbox-grid-mixins';
159+
```
160+
161+
Example : import form node_modules
162+
163+
```
164+
@use 'node_modules/flexbox-grid-mixins/dart-sass/flexbox-grid-mixins';
165+
```
166+
167+
### 2. Define the grid container
168+
169+
```
170+
.grid {
171+
@include flexbox-grid-mixins.grid();
172+
}
173+
```
174+
175+
### 3. Generate the grid columns
176+
177+
```
178+
.grid__col-3 {
179+
@include flexbox-grid-mixins.grid-col(3);
180+
}
181+
.grid__col-9 {
182+
@include flexbox-grid-mixins.grid-col(9);
183+
}
184+
```
185+
130186
## Documentation
131187

132188
See Flexbox Grid Mixins documentation: [http://thingsym.github.io/flexbox-grid-mixins/](http://thingsym.github.io/flexbox-grid-mixins/)
@@ -139,15 +195,30 @@ See Flexbox Grid Mixins documentation: [http://thingsym.github.io/flexbox-grid-m
139195

140196
* [Basic Example](http://thingsym.github.io/flexbox-grid-mixins/#Basic-Example)
141197
* [Grid System Example](http://thingsym.github.io/flexbox-grid-mixins/#Grid-System-Example)
198+
199+
### LibSass
200+
142201
* [Flexbox Grid Mixins Example](http://thingsym.github.io/flexbox-grid-mixins/example/example.html)
143202
* [Holy Grail Layout - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/holy-grail-layout.html)
144203
* [Responsive web design - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example/responsive.html)
145204
* [Unit-Set Grid (Experimental stage)](http://thingsym.github.io/flexbox-grid-mixins/example/unit-set.html)
146-
* [Box Sizing using Variable Defaults](http://thingsym.github.io/flexbox-grid-mixins/example/box-sizing.html)
205+
* [Box Sizing using Default Values](http://thingsym.github.io/flexbox-grid-mixins/example/box-sizing.html)
147206
* [Stack](http://thingsym.github.io/flexbox-grid-mixins/example/stack.html)
148207
* [Grid Type](http://thingsym.github.io/flexbox-grid-mixins/example/grid-type.html)
149208
* [Testing Stick Out Grid](http://thingsym.github.io/flexbox-grid-mixins/example/test-stick-out.html)
150209

210+
211+
### Dart Sass
212+
213+
* [Flexbox Grid Mixins Example](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/example.html)
214+
* [Holy Grail Layout - Using Flexbox Grid Mixins](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/holy-grail-layout.html)
215+
* [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)
217+
* [Box Sizing using Default Values](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/box-sizing.html)
218+
* [Stack](http://thingsym.github.io/flexbox-grid-mixins/example-dart-sass/stack.html)
219+
* [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)
221+
151222
## Package manager
152223

153224
[flexbox-grid-mixins - npm](https://www.npmjs.com/package/flexbox-grid-mixins)
@@ -185,15 +256,15 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
185256
* Version 0.2.0
186257
* update example
187258
* update package.json
188-
* add Variable Defaults flexbox-grid-mixins-stack
259+
* add Default Values flexbox-grid-mixins-stack
189260
* change margin property, remove @mixin, grid-margin and grid-col-margin
190261
* remove breakpoint value of col argument
191262
* remove condensed argument
192-
* change grid-type from argument to Variable Defaults flexbox-grid-mixins-grid-type
263+
* change grid-type from argument to Default Values flexbox-grid-mixins-grid-type
193264
* remove bower.json
194265
* add .travis.yml
195266
* Version 0.1.6
196-
* add Variable Defaults $flexbox-grid-mixins-box-sizing
267+
* add Default Values $flexbox-grid-mixins-box-sizing
197268
* update package.json
198269
* change lint from scss-lint to stylelint
199270
* Version 0.1.5

0 commit comments

Comments
 (0)