Skip to content

Commit

Permalink
v1.0.0 - left beta state
Browse files Browse the repository at this point in the history
// fixed nested declaration warnings of new DartSass in SCSS examples
// switched from legacy normalize.css to maintained csstools version
// bumped dependencies
// updated documentation
  • Loading branch information
OktarinTentakel committed Sep 23, 2024
1 parent dbf42bc commit a5c205d
Show file tree
Hide file tree
Showing 13 changed files with 91 additions and 99 deletions.
2 changes: 1 addition & 1 deletion docs/examples/css/scss-legacy.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/examples/css/scss-legacy.css.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/examples/css/scss.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/examples/css/scss.css.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/examples/css/stylus.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/examples/css/stylus.css.map

Large diffs are not rendered by default.

22 changes: 13 additions & 9 deletions docs/examples/scss/examples.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

@mixin render(){
%example-grid {
@include grid-container();

position: relative;

padding: gutter-value();
border: 3px solid red;

@include grid-container();

&:before {
content: '';

Expand All @@ -23,12 +23,12 @@

background-size: cover;
background-position: center center;
filter: saturate(150%) brightness(38%);

@include attributes-for-breakpoints((
'background-color' : $GRID_CONTAINER_BACKGROUNDCOLOR,
'background-image' : $GRID_CONTAINER_BACKGROUNDIMAGE
));

filter: saturate(150%) brightness(38%);
}

@include breakpoint(medium){
Expand Down Expand Up @@ -409,8 +409,10 @@

@include spacing-based-attribute('height', 'xxl', 3.0);

margin: gutter-value() * -1;
margin-bottom: 0;
&{
margin: gutter-value() * -1;
margin-bottom: 0;
}

@include breakpoint(medium){
margin: gutter-value() * -1;
Expand Down Expand Up @@ -548,19 +550,21 @@


&:nth-of-type(5){
order: 5;

margin: gutter-value() * -1;
margin-top: gutter-value($direction:vertical);

&:before {
content: 'Footer';
}

@include grid-item(12);
order: 5;

@include spacing-based-attributes((
'padding-top' : 'md',
'padding-bottom' : 'xl'
));
margin: gutter-value() * -1;
margin-top: gutter-value($direction:vertical);

@include breakpoint(medium){
margin: gutter-value() * -1;
Expand Down
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const
//###[ FUNCTIONS ]######################################################################################################

function compileNormalize(){
return gulp.src(`${NODE_DIR}/normalize.css/normalize.css`)
return gulp.src(`${NODE_DIR}/@csstools/normalize.css/normalize.css`)
.pipe(sourcemaps.init())
.pipe(gulpSass(nodeSass)({
outputStyle : 'compressed'
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name" : "@oktarintentakel/jig",
"version" : "0.1.12-beta",
"version" : "1.0.0",
"author" : "Sebastian Schlapkohl",
"description" : "A \"foundationish\" grid solution for SCSS and Stylus with native CSS grid and sane defaults and helpers for responsive websites.",
"license" : "MIT",
Expand Down Expand Up @@ -29,6 +29,7 @@
},

"devDependencies" : {
"@csstools/normalize.css" : "^11.0.1",
"del": "^7.1.0",
"fancy-log": "^2.0.0",
"gulp" : "^4.0.2",
Expand All @@ -40,9 +41,8 @@
"gulp-stylus" : "^3.0.1",
"jsdoc" : "^3.6.11",
"node-sass" : "~9.0.0",
"normalize.css" : "^8.0.1",
"sass" : "~1.77.5",
"serve-static" : "^1.15.0",
"sass" : "~1.79.3",
"serve-static" : "^1.16.2",
"stylus" : "~0.63.0",
"yargs" : "^17.7.2"
}
Expand Down
19 changes: 4 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,6 @@ by Sebastian Schlapkohl



A Word of Caution
-----------------
This package has reached beta status. Everything included is tested with browser examples. And the contents include
everything I aimed for in the first version. Although everything is finished from a technical perspective, this package
is not yet battle-proven.

The beta should be fine to use (cautiously), but I will delay the bump to version 1.0.0 stable until after I've used
this in a real-world project.



What is This?
-------------
Browsers have long moved on from table and float layouts, moved past flex layouts and finally arrived at native grids.
Expand Down Expand Up @@ -136,7 +125,7 @@ yarn add oktarintentakel/jig#vX.X.X

### Using an Alias Location

In many cases (especially when installing directly from Github repository) it makes sense to define an install alias,
In many cases (especially when installing directly from Github repository) it makes sense to define an installation alias,
to manually define a folder inside `node_modules` to install to.

Using NPM
Expand Down Expand Up @@ -178,7 +167,7 @@ or with Github repository
It may be a good idea, to generally split node and client packages up. Why? Client packages are delivered directly to
the client and are executed and interpreted on the user's machine. So, these packages have a different set of rules
applying to them. For example: it is not really clever to give client packages an approximate version, like a normal
node dependency using `^` oder `~`, because every minor change in a client package may affect all receiving clients
node dependency using `^` or `~`, because every minor change in a client package may affect all receiving clients
after a reevaluation of npm versions. This is a nightmare, because this means, that, at undetermined points in time, all
cross-browser testing you did may be invalid and since you are not seeing everything while developing all the time, your
app may fall apart on certain devices, without you knowing.
Expand All @@ -189,7 +178,7 @@ mentioned problems. That is very unpractical for both usages and each should be
purpose, since they are used for different things on very different machines, even if it is the same package under the
hood.

So I generally propse separating all npm packages, that are delivered to the client directly in any way into a specific
So I generally propose separating all npm packages, that are delivered to the client directly in any way into a specific
`@client` package in `node_modules` using fixed versioning for these (I originally got the idea when I transitioned)
from bower to npm, reading the bower team's [ideas](https://bower.io/blog/2017/how-to-migrate-away-from-bower/) about
this.
Expand Down Expand Up @@ -270,7 +259,7 @@ or (if you want to have more control about what to include)
@require 'jig/spacing'
```

But this is just the absolute minimum. Of course you'll want to customize the grid and the layout, by providing
But this is just the absolute minimum. Of course, you'll want to customize the grid and the layout, by providing
detailed information about the structure you are trying to build. Also, we are still missing stuff like CSS
normalization here, which we'd probably like to add.

Expand Down
2 changes: 1 addition & 1 deletion source/lib/normalize/index.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a5c205d

Please sign in to comment.