This repository was archived by the owner on Oct 2, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2690708
commit 8b63be6
Showing
165 changed files
with
7,487 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"directory": "vendor" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# EditorConfig helps developers define and maintain consistent | ||
# coding styles between different editors and IDEs | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
# Settings | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.css] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.scss] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.js] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
[*.json] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.yml] | ||
# Indentation style | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.sass-cache | ||
.DS_Store | ||
_site/ | ||
css/ | ||
vendor/ | ||
bower_components/ | ||
node_modules/ | ||
npm-debug.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
0.12.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributing | ||
|
||
You are free to contribute to Chopstick via GitHub Pull Requests. We have a couple of simple guidelines we try to follow, of which most are taken from the [CSS Tricks Sass Style Guide](http://css-tricks.com/sass-style-guide) | ||
|
||
|
||
## Git branch model | ||
[A successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/) | ||
|
||
|
||
## Releases | ||
[Semantic versioning](http://semver.org/) | ||
|
||
|
||
## How to pull request | ||
|
||
1. [Fork](https://github.com/getchopstick/chopstick-boilerplate/fork) this repo. | ||
2. Create a branch `git checkout -b feature--name` | ||
3. Commit your changes `git commit -am "New feature"` | ||
4. Push to the branch `git push origin feature--name` | ||
5. Open a [Pull Request](https://github.com/getchopstick/chopstick-boilerplate/pulls) | ||
|
||
|
||
## Coding style | ||
|
||
We use [Editorconfig](http://editorconfig.org/) to maintain a consistent coding style. Please take care of proper spacing and indenting. | ||
|
||
|
||
## Naming and namespaces | ||
We use the [BEM](http://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/) naming methodology: | ||
|
||
- `.block` for sole root of the component (eg: .c-widget) | ||
- `.block__element` for a component part of the block (eg: .c-widget__title) | ||
- `.block--modifier` for a variant or extension of the block (eg: .c-widget--full) | ||
|
||
Follow these rules for namespacing: | ||
- `.o-` for object classes (eg: .o-media) | ||
- `.c-` for component classes (eg: .c-widget) | ||
- `.t-` for theming classes (eg: .t-header) | ||
- `.u-` for utility classes (eg: .u-1-of-2) | ||
- `.is-`/`.has-` for stateful classes (eg: .is-active) | ||
- .js for javascript hooks | ||
- `._` for temporary hacks/fixes | ||
|
||
## SCSS order | ||
|
||
1. Regular styles | ||
2. @includes | ||
|
||
Example: | ||
|
||
.c-component { | ||
background: #fff; | ||
@include transition(all 0.3s ease); | ||
} | ||
|
||
|
||
## Extends | ||
|
||
Don't use @extends as they have a tendency to cause css bloat and long selectors. | ||
|
||
|
||
## Nesting | ||
|
||
Try to avoid nesting. We follow a single-depth-class-based architecture. | ||
|
||
|
||
## Global files | ||
|
||
Only `@include` in the global screen.scss file. Never write SCSS directly in screen.scss. Order of importing is always as described in `screen.scss`. | ||
|
||
|
||
## Be generous with comments | ||
|
||
Comments get filtered out when compiling. If you do *anything* that can not be immediately understood: comment it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# ~/Gemfile | ||
|
||
source "http://rubygems.org" | ||
|
||
group :development do | ||
# CSS Preprocessing | ||
gem 'sass' | ||
|
||
# Jekyll | ||
gem 'jekyll' | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
GEM | ||
remote: http://rubygems.org/ | ||
specs: | ||
blankslate (2.1.2.4) | ||
celluloid (0.16.0) | ||
timers (~> 4.0.0) | ||
classifier-reborn (2.0.3) | ||
fast-stemmer (~> 1.0) | ||
coffee-script (2.4.1) | ||
coffee-script-source | ||
execjs | ||
coffee-script-source (1.9.1.1) | ||
colorator (0.1) | ||
execjs (2.5.2) | ||
fast-stemmer (1.0.2) | ||
ffi (1.9.8) | ||
hitimes (1.2.2) | ||
jekyll (2.5.3) | ||
classifier-reborn (~> 2.0) | ||
colorator (~> 0.1) | ||
jekyll-coffeescript (~> 1.0) | ||
jekyll-gist (~> 1.0) | ||
jekyll-paginate (~> 1.0) | ||
jekyll-sass-converter (~> 1.0) | ||
jekyll-watch (~> 1.1) | ||
kramdown (~> 1.3) | ||
liquid (~> 2.6.1) | ||
mercenary (~> 0.3.3) | ||
pygments.rb (~> 0.6.0) | ||
redcarpet (~> 3.1) | ||
safe_yaml (~> 1.0) | ||
toml (~> 0.1.0) | ||
jekyll-coffeescript (1.0.1) | ||
coffee-script (~> 2.2) | ||
jekyll-gist (1.2.1) | ||
jekyll-paginate (1.1.0) | ||
jekyll-sass-converter (1.3.0) | ||
sass (~> 3.2) | ||
jekyll-watch (1.2.1) | ||
listen (~> 2.7) | ||
kramdown (1.6.0) | ||
liquid (2.6.2) | ||
listen (2.10.0) | ||
celluloid (~> 0.16.0) | ||
rb-fsevent (>= 0.9.3) | ||
rb-inotify (>= 0.9) | ||
mercenary (0.3.5) | ||
parslet (1.5.0) | ||
blankslate (~> 2.0) | ||
posix-spawn (0.3.11) | ||
pygments.rb (0.6.3) | ||
posix-spawn (~> 0.3.6) | ||
yajl-ruby (~> 1.2.0) | ||
rb-fsevent (0.9.4) | ||
rb-inotify (0.9.5) | ||
ffi (>= 0.5.0) | ||
redcarpet (3.2.3) | ||
safe_yaml (1.0.4) | ||
sass (3.4.13) | ||
timers (4.0.1) | ||
hitimes | ||
toml (0.1.2) | ||
parslet (~> 1.5.0) | ||
yajl-ruby (1.2.1) | ||
|
||
PLATFORMS | ||
ruby | ||
|
||
DEPENDENCIES | ||
jekyll | ||
sass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Chopstick License | ||
|
||
Copyright (C) 2013–2015 [Wijs](https://wijs.be/en) | ||
|
||
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: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
# Inuit CSS License | ||
|
||
Inuit is used for: | ||
|
||
- _base.box-sizing.scss | ||
|
||
Copyright 2014 Harry Roberts | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
title: Chopstick | ||
exclude: ['_site','scss','*scss','Gem*','Guard*','*rb','.sass-cache','.git*','config.rb','*.md','*.json','docroot','node_modules','gulpfile.js'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
// --- | ||
// CONFIG FILE | ||
// Define your tasks & variables here | ||
// --- | ||
|
||
module.exports = { | ||
|
||
scss: { | ||
screen : 'scss/screen.scss', | ||
src : 'scss/**/*.scss', | ||
settings : { | ||
bundleExec: true, | ||
sourcemap: true, | ||
style: 'compact' | ||
}, | ||
cssDest : 'css/', | ||
jekyllCssDes : '_site/css/', | ||
prefix : [ // Autoprefixer supported browsers | ||
'last 2 version', | ||
'> 1%', | ||
'ie 8', | ||
'ie 9', | ||
'ios 6', | ||
'android 4' | ||
] | ||
}, | ||
|
||
js : { | ||
src : [ // source js file | ||
'js/theme.js', | ||
'js/_components/*.js', | ||
'js/loader.js' | ||
|
||
], | ||
concatFilename : 'theme.concat.js', // result filename | ||
jekyllJsDest : '_site/js/', | ||
jsDest : 'js/' | ||
}, | ||
|
||
jekyll : { | ||
buildMessage: '<span style="color: grey">Building</span> jekyll' | ||
}, | ||
|
||
browsersync : { | ||
server: { | ||
baseDir: './_site', | ||
reloadDelay: 2000, | ||
debounce: 200, | ||
notify: true, | ||
ghostMode: { | ||
clicks: true, | ||
location: true, | ||
forms: true, | ||
scroll: false | ||
} | ||
} | ||
}, | ||
|
||
watch : { | ||
jekyllSource : [ // Files that trigger a Jekyll rebuild | ||
'img/*.png', | ||
'img/*.jpg', | ||
'img/*.svg', | ||
'_includes/**/*.html', | ||
'_layouts/*.html', | ||
'_posts/*.md', | ||
'_data/*.yml', | ||
'*.html' | ||
] | ||
}, | ||
|
||
compressjs : { | ||
src : 'js/*.js', | ||
dest : '_site/js/' | ||
}, | ||
|
||
svg2png : { | ||
src: "./img/svg/*.svg", | ||
settings : { | ||
scaling : 2, // The scaling factor (optional; default=1.0) | ||
verbose: false // Logs progress information (optional; default=false) | ||
}, | ||
dest : "./img/png" | ||
} | ||
|
||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
// --- | ||
// BROWSERSYNC | ||
// --- | ||
|
||
// plugins | ||
var gulp = require('gulp'), | ||
browserSync = require('browser-sync'); | ||
|
||
// configfile | ||
var config = require('../config').browsersync; | ||
|
||
|
||
// tasks | ||
gulp.task('browsersync', function() { | ||
browserSync.init(config); | ||
}); | ||
|
||
gulp.task('browsersyncReload', function() { | ||
browserSync.reload(); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// --- | ||
// COMPRESSJS TASK | ||
// (puts files together, minifies and saves as 'scripts.min.js') | ||
// --- | ||
|
||
// plugins | ||
var gulp = require('gulp'), | ||
uglyfly = require('gulp-uglyfly'); | ||
|
||
var config = require('../config').compressjs; | ||
|
||
//task | ||
gulp.task('compressjs', function() { | ||
gulp.src(config.src) | ||
.pipe(uglyfly()) | ||
.pipe(gulp.dest(config.dest)) | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// --- | ||
// DEFAULT TASK (when calling gulp) | ||
// --- | ||
|
||
// plugins | ||
var gulp = require('gulp'); | ||
|
||
// task | ||
gulp.task('default', [ | ||
'scss', | ||
'js', | ||
'jekyll--build' | ||
]); |
Oops, something went wrong.