mrmrs / nkd

Template for jekyll project with postcss and browser-sync

Checkout http://mrmrs.io/nkd

NKD

Light-weight template for a responsive HTML5/SCSS Jekyll project

NKD just works. Start developing your prototype in jekyll without any of the boring setup.

Features

• Modular file structure, easy to extend or get rid of existing code.
• Mobile friendly responsive type scale
• A light-weight SCSS base that starts with Normalize.css - 1.2KB minified / 214B gzipped.
• Thoroughly commented code (Easy to get going if it's your first jekyll project)
• Two media queries for tablet and desktop size screens. Lends itself to mobile-first design.

Getting started

• Create a new repo for your project on Github
• In terminal run

    git clone [email protected]:mrmrs/nkd.git [yourNewRepoName]
    cd [yourNewRepoName]
    npm install && npm start

If you want to set this up as your own github project you'll want to do the following.

    rm -rf .git
    git init
    git remote add origin [email protected]:[yourUserName]/[yourNewRepoName].git
    git remote -v
    origin [email protected]:[yourUserName]/[yourNewRepoName].git (fetch)
    origin  [email protected]:[yourUserName]/[yourNewRepoName].git (push)

• Once you add & commit files you are ready to publish run:

git push -u origin master

Batteries Not Included

File structure is as follows:

nkd                                 [ Site root ]
  ├── README.md                     [ You are here ]
  ├── package.json                  [ project info and npm dependencies ]
  ├── gulpfile.js                       [ Automated js tasks ]
  ├── _config.yml                   [ Site options ]
  ├── _development_config.yml                   [ Site options ]
  ├── _includes
  │   ├── _footer.html
  │   ├── _head.html
  │   ├── _js_includes.html
  │   └── _navigation_main.html
  ├── _layouts
  │   ├── default.html
  │   └── post.html
  ├── _posts
  │   └── 2020-01-01-example.html
  ├── _resources
  │   └── favicons.ai
  ├── _sass
  │   ├── _grid.scss
  │   ├── _normalize.scss           [http://necolas.github.io/normalize.css/]
  │   ├── _queries.scss             [Configurable media queries]
  │   ├── _styles.scss
  │   ├── _type.scss
  │   ├── _variables.scss
  │   └── nkd.scss                    [Imports .scss files, compiles to css/nkd.css]
  ├── css
  │   └── nkd.css                     [1.8KB minified / 214B gzipped - includes normalize.css]
  ├── favicon.icns
  ├── favicon.ico
  ├── index.html                    [index file that's served up at root. The "homepage" if you will.]
  ├── touch-icon-ipad-precomposed.png
  ├── touch-icon-ipad-retina-precomposed.png
  ├── touch-icon-iphone-precomposed.png
  └── touch-icon-iphone-retina-precomposed.png

Resources

There is an included Adobe Illustrator file that has artboards for every favicon size you'll need. If you're into that sort of thing. There are premade favicons you will want to replace or remove reference to.

Author

MRMRS

License

The MIT License (MIT)

Copyright (c) 2015 @mrmrs

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.

nkd's Issues

Typos in permalink section of _config.yml

# Variable format options for URL styles below
# ============================================================
# pretty                                          => /2009/04/29/slap-chop/index.html
# /:month-month:day-:year/:title.html/            => 04-29-2009/slap-chop.html
# /blog/:yearr/:month/:day/:title                 => /blog/2009/04/29/slap-chop/index.html

I'm pretty sure yearr is a typo and I think :month-month:day should be :month-:day. It'd probably be good to just link to http://jekyllrb.com/docs/permalinks/ too.

npm install gulp-sass error

There seems to be an issue on fresh install

fatal error: too many errors emitted, stopping now [-ferror-limit=]
20 errors generated.
make: *** [Release/obj.target/binding/binding.o] Error 1
gyp ERR! build error
gyp ERR! stack Error: `make` failed with exit code: 2
gyp ERR! stack     at ChildProcess.onExit (/usr/local/lib/node_modules/npm/node_modules/node-gyp/lib/build.js:270:23)
gyp ERR! stack     at emitTwo (events.js:87:13)
gyp ERR! stack     at ChildProcess.emit (events.js:172:7)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:200:12)
gyp ERR! System Darwin 15.3.0
gyp ERR! command "/usr/local/bin/node" "/usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
gyp ERR! cwd /Users/alex/dev/alextrastero.github.io/node_modules/gulp-sass/node_modules/node-sass
gyp ERR! node -v v4.2.3
gyp ERR! node-gyp -v v3.0.3
gyp ERR! not ok
Build failed
npm ERR! Darwin 15.3.0
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "i"
npm ERR! node v4.2.3
npm ERR! npm  v2.14.7
npm ERR! code ELIFECYCLE

npm ERR! [email protected] install: `node build.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] install script 'node build.js'.
npm ERR! This is most likely a problem with the node-sass package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     node build.js
npm ERR! You can get their info via:
npm ERR!     npm owner ls node-sass
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     /Users/alex/dev/alextrastero.github.io/npm-debug.log

Foreman the CPU Killer

When I start foreman, "ruby" very quickly consumes 90-110% of my CPU. When I stop foreman, "ruby" drops and I'm once-again able to use my machine, which is a new 4GB Macbook Air running the latest versions of OS X and Ruby (10.9.3 and 2.1.2).

I know this might not be a NKD issue, but I know nothing about foreman, and I really wanna use NKD. Any thoughts? I literally can't use my machine while it's running.

Gulp Production Error

Getting an issue when running gulp production
console output is below:

Assertion failed: (handle->InternalFieldCount() > 0), function Unwrap, file ../src/node_object_wrap.h, line 61.
Abort trap: 6

package.json syntax error

package.json is missing a comma on line 22

Should the links in _head.html be absolute?

I was trying this out and noticed a bunch of 404s for the favicon and i.css files. I think the links in _head.html should either be absolute, e.g. href="/favicon.ico" or include the liquid tag for the site root: href="{{ site.url }}/favicon.ico".

Browser Sync not seem to work -- fix

Hi
Thanks for sharing this but browser sync did not seem to work on my Mac Os 10.9.5 and chrome. It loaded the first time but would not refresh:

gulpfile.js I needed to correct the paths to the files of the sass and site files.

gulp.task('default', ['pre-process', 'minify-css', 'bs-reload', 'browser-sync'], function(){
gulp.start('pre-process', 'csslint');
gulp.watch(['includes/', 'layouts/', 'posts/', 'resources/', 'sass/', '.html', '__config.yml'], ['jekyll-build']);
gulp.watch('sass/.scss', ['pre-process', 'minify-css']);
gulp.watch('css/nkd.css', ['bs-reload', 'minify-css']);
gulp.watch('*.html', ['bs-reload'])
});

Changed to

gulp.task('default', ['pre-process', 'minify-css', 'bs-reload', 'browser-sync'], function(){
gulp.start('pre-process', 'csslint');
gulp.watch(['includes/', 'layouts/', 'posts/', 'resources/', 'sass/', '_.html', '__config.yml'], ['jekyll-build']);
gulp.watch('sass/.scss', ['pre-process', 'minify-css']);
gulp.watch('_site/css/nkd.css', ['bs-reload', 'minify-css']);
gulp.watch('_site/*.html', ['bs-reload'])
});