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.
- 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.
- Create a new repo for your project on Github
- In terminal run
git clone firstname.lastname@example.org: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@example.com:[yourUserName]/[yourNewRepoName].git git remote -v origin firstname.lastname@example.org:[yourUserName]/[yourNewRepoName].git (fetch) origin email@example.com:[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
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.
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.