Skip to content

Commit b9af8ab

Browse files
committed
3.1.0-beta1
1 parent 5bd0c23 commit b9af8ab

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1170
-1015
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ yarn.lock
44
node_modules/
55
bower_components/
66
.editorconfig
7+
main.scss
8+
index.html

README.md

Lines changed: 90 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,16 @@ If you're using a `bower`, `npm`, or `yarn` then install via:
3030
bower i --save-dev skeleton-sass
3131
bower i --save-dev skeleton-sass-official
3232
npm i --save-dev skeleton-sass-official
33-
yarn install skeleton-sass-official
33+
yarn install skeleton-sass-official --dev
3434
~~~
3535

3636
Optionally, if you are not using one of these package managers, then you can clone the repo and put in a special directory with the rest of your dependencies.
3737

38+
~~~bash
39+
cd path/to/my_dir
40+
git clone https://github.com/atomicpages/skeleton-sass.git
41+
~~~
42+
3843
From here, minimal stitching is required to get Skeleton Sass 3 integrated into your project! At a minimum, you need to create a single file: `skeleton.scss`
3944

4045
From \*nix:
@@ -61,8 +66,8 @@ Inside of `skeleton.scss` we need to add our components:
6166
@import "path/to/bower_components/skeleton-sass/skeleton/themes/fresh/vars"; // theme variable overrides
6267
6368
// import default theme styles
64-
@import "path/to/bower_components/skeleton-sass/skeleton/themes/fresh/base"; // theme base styles
65-
@import "path/to/bower_components/skeleton-sass/skeleton/themes/fresh/skeleton"; // theme grid styles
69+
@import "path/to/bower_components/skeleton-sass/skeleton/themes/fresh/include\_components"; // theme base styles
70+
@import "path/to/bower_components/skeleton-sass/skeleton/themes/fresh/grid"; // theme grid styles
6671
~~~
6772

6873
Compile `skeleton.scss` and you now have Skeleton Sass 3 integrated into your project!
@@ -79,12 +84,20 @@ my_project
7984
├── _config.scss # Global overrides and applies to all themes
8085
├── _loader.scss # Contains all of the imports
8186
└── my_theme
82-
├── _base.scss # Theme base styles, replaces shipped base styles
83-
├── _skeleton.scss # Theme grid, replaces shipped grids
84-
├── _vars.scss # Theme-scoped variables and overrides
85-
└── marrow
86-
├── _private.scss # Private mixins, conventionally only available to _public.scss
87-
└── _public.scss # Public-facing mixins available to the theme
87+
├── _grid.scss # Theme grid, replaces shipped grids
88+
├── \_include_components.scss # Includes all of the components in the components folder
89+
├── _vars.scss # Theme-scoped variables and overrides
90+
├── components
91+
│ ├── _base.scss # Default html and body styles
92+
│ ├── _buttons.scss
93+
│ ├── _forms.scss
94+
│ ├── _links.scss
95+
│ ├── _lists.scss
96+
│ ├── _typography.scss
97+
│ └── _utils.scss # Utility classes
98+
└── mixins
99+
├── _private.scss # Contains all "private" mixins
100+
└── _public.scss # Contains all public mixins
88101
```
89102

90103
Now that we have our sample project outlined, let's see how we can get everything working! Open `_config.scss` and add the following:
@@ -104,8 +117,8 @@ Now open `_loader.scss` and add the following:
104117
105118
// import theme, overrides, and extras
106119
@import "themes/MyTheme/vars";
107-
@import "themes/MyTheme/base";
108-
@import "themes/MyTheme/skeleton";
120+
@import "themes/MyTheme/include_components";
121+
@import "themes/MyTheme/grid";
109122
~~~
110123

111124
Finally, open `skeleton.scss` and add the following as the first line of the file:
@@ -124,14 +137,14 @@ For example, let's assume we want to use font-awesome inside of our `skeleton.sc
124137
125138
// import theme, overrides, and extras
126139
@import "themes/MyTheme/vars";
127-
@import "themes/MyTheme/base";
128-
@import "themes/MyTheme/skeleton";
140+
@import "themes/MyTheme/include_components";
141+
@import "themes/MyTheme/grid";
129142
130143
// import extras
131144
@import "../../../bower_components/font-awesome/scss/font-awesome";
132145
~~~
133146

134-
**Note:** the position of the import changes which files have access to the loaded data. For example, if you need the data in `themes/MyTheme/skeleton` then you'd need to move the import above the line where you import `themes/MyTheme/skeleton`.
147+
**Note:** the position of the import changes which files have access to the loaded data. For example, if you need the data in `themes/MyTheme/grid` then you'd need to move the import above the line where you import `themes/MyTheme/grid`.
135148

136149
For more information on why we made this change, [click here](#change).
137150

@@ -158,31 +171,63 @@ Skeleton Sass is a Sass port of Skeleton CSS. Skeleton Sass 3 decouples itself f
158171
### Features
159172
1. Modular
160173
2. Decoupled core code
161-
3. Extensible
162-
4. Themeable
174+
3. Decoupled theme files for rapid theme development
175+
4. Extensible
163176

164177
### File Overview
165178
```
166-
Skeleton # Where all of the magic happens
179+
skeleton/ # Where all of the magic happens
167180
├── core
168-
│   ├── _config.scss # Default global configuration variables
169-
│   ├── _dependencies.scss # Default global logic for Skeleton Sass
170-
│   ├── _functions.scss # Default global functions for Skeleton Sass
171-
│   └── _mixins.scss # Default global mixins for Skeleton Sass
172-
└── themes # Where all of the themes live
181+
│   ├── _config.scss # Default global configuration variables
182+
│   ├── _dependencies.scss # Default global logic for Skeleton Sass
183+
│   ├── _functions.scss # Default global functions for Skeleton Sass
184+
│   └── _mixins.scss # Default global mixins for Skeleton Sass
185+
└── themes # Where all of the themes live
173186
├── fresh
174-
│   ├── _base.scss contains # All of the base styles for Skeleton Sass with the exception of the reset styles
175-
│   ├── _skeleton.scss
176-
│   ├── _vars.scss # Project-scoped configuration options and variables
177-
│   └── marrow # Stores all project-level functions and mixins
178-
│   └── _mixins.scss # loads the default theme mixins and functions from sphenoid
179-
└── sphenoid
180-
├── _base.scss # Base styles for Skeleton Sass (same look as Skeleton CSS created)
181-
├── _skeleton.scss # Styles to create the grid
182-
├── _vars.scss # Project-scoped configuration options
183-
└── marrow #Project-scoped logic (e.g. functions and mixins) for your theme to work
184-
├── _private.scss # Private logic for the public mixins/functions to work correctly for the sphenoid project. Feel free to name this file whatever you want in your own theme.
185-
└── _public.scss # Public mixins/functions for the sphenoid theme. Feel free to name this file whatever you want in your own theme.
187+
│   ├── _grid.scss
188+
│   ├── \_include_components.scss # partial to import all of the components
189+
│   ├── _vars.scss # Project-scoped configuration options and variables
190+
│   ├── components
191+
│   │   ├── _base.scss
192+
│   │   ├── _buttons.scss
193+
│   │   ├── _forms.scss
194+
│   │   ├── _links.scss
195+
│   │   ├── _lists.scss
196+
│   │   ├── _misc.scss
197+
│   │   ├── _normalize.scss
198+
│   │   ├── _tables.scss
199+
│   │   ├── _typography.scss
200+
│   │   └── _utils.scss
201+
│   └── mixins # Stores all project-level functions and mixins
202+
│   └── _mixins.scss
203+
├── original
204+
│   ├── _grid.scss
205+
│   ├── \_include_components.scss # partial to import all of the components
206+
│   ├── _vars.scss # Project-scoped configuration options and variables
207+
│   ├── components
208+
│   │   ├── _base.scss
209+
│   │   ├── _buttons.scss
210+
│   │   ├── _forms.scss
211+
│   │   ├── _links.scss
212+
│   │   ├── _lists.scss
213+
│   │   ├── _typography.scss
214+
│   │   └── _utils.scss
215+
│   └── mixins # Stores all project-level functions and mixins
216+
│   ├── _private.scss
217+
│   └── _public.scss
218+
└── wing
219+
├── _grid.scss
220+
├── \_include_components.scss # partial to import all of the components
221+
├── _vars.scss # Project-scoped configuration options and variables
222+
└── components
223+
├── _base.scss
224+
├── _buttons.scss
225+
├── _forms.scss
226+
├── _links.scss
227+
├── _lists.scss
228+
├── _misc.scss
229+
├── _typography.scss
230+
└── _utils.scss
186231
```
187232

188233
Install Skeleton Sass with bower via command line:
@@ -196,14 +241,14 @@ You can also add Skeleton Sass as a dependency via NPM or Yarn!
196241

197242
~~~bash
198243
npm install --save-dev skeleton-sass-official
199-
yarn install skeleton-sass-official
244+
yarn install skeleton-sass-official --dev
200245
~~~
201246

202247
You can also install alpha, beta, release candidate, and previous versions by looking at the [releases](https://github.com/atomicpages/skeleton-sass/releases) page and install with the following syntax:
203248

204249
~~~bash
205250
bower install skeleton-sass#[tag]
206-
bower install skeleton-sass#3.0.2
251+
bower install skeleton-sass#3.1.0
207252
~~~
208253

209254
[Learn how to set up Skeleton Sass for the first time here](https://github.com/atomicpages/skeleton-sass/wiki/Setting-up-Skeleton-Sass-for-first-time-use).
@@ -254,6 +299,15 @@ Changelog
254299
* Added new demos
255300
* Better styling
256301
* Less clutter
302+
* Splitting base styles into several components to accelerate theme development and reduce file coupling.
303+
* `_base.scss`
304+
* `_buttons.scss`
305+
* etc...
306+
* Adding `_include_components.scss` partial in every theme for easy loading
307+
* Standardizing naming conventions
308+
* Renaming `sphenoid` theme to `original`
309+
* Renaming `marrow` folders to `mixins`
310+
* Renaming `_skeleton.scss` to `_grid.scss`
257311

258312
### 3.0.3
259313
* Addressing issue #24

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "skeleton-sass",
3-
"version": "3.0.2",
3+
"version": "3.1.0",
44
"author": "Dennis Thompson",
55
"homepage": "http://atomicpages.github.io/skeleton-sass/",
66
"repository": {

gulpfile.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
const gulp = require('gulp');
2+
const sass = require('gulp-sass');
3+
const del = require('del');
4+
const sourcemaps = require('gulp-sourcemaps');
5+
6+
gulp.task('clean', function () {
7+
return del('main.css*');
8+
});
9+
10+
gulp.task('sass', ['clean'], function () {
11+
return gulp.src('main.scss')
12+
.pipe(sourcemaps.init())
13+
.pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError))
14+
.pipe(sourcemaps.write('.'))
15+
.pipe(gulp.dest('.'));
16+
});
17+
18+
gulp.task('default', ['sass']);

license.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The MIT License (MIT)
2-
Copyright (c) 2016 AtomicPages LLC
2+
Copyright (c) 2017 AtomicPages LLC
33

44
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
55

package.json

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "skeleton-sass-official",
3-
"version": "3.0.2",
3+
"version": "3.1.0",
44
"description": "Skeleton Sass is a highly modular version of Skeleton CSS",
55
"main": "skeleton/core/_config.scss",
66
"scripts": {
@@ -11,12 +11,12 @@
1111
"url": "git+https://github.com/atomicpages/skeleton-sass.git"
1212
},
1313
"keywords": [
14+
"scss",
1415
"sass",
1516
"skeleton",
16-
"front-end",
17+
"frontend",
1718
"css",
18-
"boilerplate",
19-
"scss"
19+
"boilerplate"
2020
],
2121
"author": "Dennis Thompson",
2222
"license": "MIT",
@@ -26,5 +26,13 @@
2626
"homepage": "https://github.com/atomicpages/skeleton-sass#readme",
2727
"dependencies": {
2828
"normalize-scss": ">=5.0.4"
29+
},
30+
"devDependencies": {
31+
"del": ">=2.2.2",
32+
"gulp": "^3.9.1",
33+
"gulp-cli": ">=1.2.2",
34+
"gulp-sass": ">=3.1.0",
35+
"gulp-sourcemaps": "^2.4.0",
36+
"sassdoc": ">=2.1.20"
2937
}
3038
}

0 commit comments

Comments
 (0)