@@ -9,8 +9,10 @@ Start developing your prototype in [jekyll](http://jekyllrb.com "Jekyll - Simple
9
9
without any of the boring setup.
10
10
11
11
# Features
12
+
12
13
* Modular file structure, easy to extend or get rid of existing code.
13
14
* Mobile friendly responsive type scale
15
+ * A solid SCSS base that starts with Normalize.css
14
16
* Thoroughly commented code (Easy to get going if it's your first jekyll project)
15
17
* Two media queries for tablet and desktop size screens. Lends itself to mobile-first design.
16
18
@@ -37,39 +39,52 @@ without any of the boring setup.
37
39
git push -u origin master
38
40
```
39
41
40
-
42
+ # Batteries Not Included
41
43
42
44
File structure is as follows:
43
45
44
- <pre >
45
- nkd [ Site root]
46
- ├── README.md [What you're reading now]
47
- ├── Rakefile [Rake sass, rake dev]
48
- ├── _config.yml [Config for site. You can run jekyll without a _config.yml file if you want]
49
- ├── _includes [Common includes I need for sites / pages]
50
- │ ├── _footer.html [_BLANK_]
51
- │ ├── _head.html [Common header elements]
52
- │ ├── _js_includes.html [_BLANK_]
53
- │ └── _navigation_main.html [_BLANK_]
54
- ├── _layouts [Two layout files: default and post. both are identical by default.]
55
- │ ├── default.html
56
- │ └── post.html
57
- ├── _posts [Directory where you'd put posts...if you want any]
46
+ ```
47
+ nkd [ Site root ]
48
+ ├── README.md [ You are here ]
49
+ ├── Rakefile [ Rake tasks! ]
50
+ ├── _config.yml [ Site options ]
51
+ ├── _includes
52
+ │ ├── _footer.html
53
+ │ ├── _head.html
54
+ │ ├── _js_includes.html
55
+ │ └── _navigation_main.html
56
+ ├── _layouts
57
+ │ ├── default.html
58
+ │ └── post.html
59
+ ├── _posts
60
+ │ └── 2020-01-01-example.html
61
+ ├── _resources
62
+ │ └── favicons.ai
58
63
├── _sass
59
- │ ├── _grid.scss [Blank media queries. Not included or compiled to css]
60
- │ ├── i.scss [Includes normalize - compiles to i.css]
61
- │ └── normalize.scss
64
+ │ ├── _grid.scss
65
+ │ ├── _normalize.scss [http://necolas.github.io/normalize.css/]
66
+ │ ├── _queries.scss [Configurable media queries]
67
+ │ ├── _styles.scss
68
+ │ ├── _type.scss
69
+ │ ├── _variables.scss
70
+ │ └── i.scss [Imports .scss files, compiles to css/i.css]
62
71
├── css
63
- │ ├── i.css
64
- └── index.html [index file that's served up at root. The "homepage" if you will.]
65
- </pre >
72
+ │ └── i.css [1.8KB minified / 214B gzipped - includes normalize.css]
73
+ ├── favicon.icns
74
+ ├── favicon.ico
75
+ ├── index.html [index file that's served up at root. The "homepage" if you will.]
76
+ ├── touch-icon-ipad-precomposed.png
77
+ ├── touch-icon-ipad-retina-precomposed.png
78
+ ├── touch-icon-iphone-precomposed.png
79
+ └── touch-icon-iphone-retina-precomposed.png
80
+ ```
66
81
67
82
# Rake Tasks
68
- ## WAIT I'M A DESIGNER WHAT IS RAKE
83
+ ## WAIT I'M A DESIGNER WHAT IS RAKE
69
84
Rake is super simple. Don't be afraid. In this instance it's used to map unix commands
70
85
to "rake tasks". It's a lot easier to remember 'rake dev' then jekyll serve --watch, well
71
86
it is for me anyways. If you don't like any of these commands, don't be scared. Rakefile
72
- is a super easy file to edit.
87
+ is a super easy file to edit - even if it looks scary because it doesn't have an extension.
73
88
74
89
Start the jekyll server on port 4000. Preview in your browser at http://localhost:4000
75
90
### rake dev
0 commit comments