You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-30Lines changed: 13 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
### About
4
4
Project Zeppelin allows you to setup awesome GDG DevFest site in 5 minutes.
5
5
6
-
Project is builded on top of [Jekyll](http://jekyllrb.com/) - simple, blog-aware, static site generator. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your website from GitHub’s servers for free. [Learn more about Jekyll](http://jekyllrb.com/).
6
+
Project is built on top of [Jekyll](http://jekyllrb.com/) - simple, blog-aware, static site generator. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your website from GitHub’s servers for free. [Learn more about Jekyll](http://jekyllrb.com/).
7
7
8
8
Template is brought by [GDG Lviv](http://lviv.gdg.org.ua/) team.
9
9
@@ -30,11 +30,16 @@ Or watch project presentation from [GDG[x] Townhall meeting](http://www.youtube.
30
30
31
31
## Local development
32
32
33
-
Check if you have [all requirments for local environment](http://jekyllrb.com/docs/installation/), install [Jekyll server](http://jekyllrb.com/docs/quickstart/) gem.
34
-
Install GitHub pages
33
+
Check if you have [all requirements for local environment](http://jekyllrb.com/docs/installation/).
34
+
To install all development dependencies install [Bundler](http://bundler.io/).
35
35
```bash
36
-
gem install github-pages
36
+
gem install bundler
37
37
```
38
+
and run next command from root folder:
39
+
40
+
```bash
41
+
bundle install
42
+
```
38
43
39
44
Run this command from project root folder:
40
45
```bash
@@ -45,22 +50,7 @@ Site will be available at http://127.0.0.1:4000/zeppelin/ or http://localhost:40
45
50
**NOTE:** in this mode all changes to html and data files will be automatically regenerated, but after changing ```_config.yml``` you have to restart server.
46
51
47
52
### Sass(Compass) support
48
-
Install the latest version of [Compass](http://compass-style.org/). Ruby uses Gems to manage its various packages of code like Sass. In your open terminal window type:
49
-
```bash
50
-
gem install compass --pre
51
-
```
52
-
53
-
Then for combining media queries you can use [Sass::MediaQueryCombiner](https://github.com/aaronjensen/sass-media_query_combiner) plugin. Install with command
54
-
```bash
55
-
gem install sass-media_query_combiner
56
-
```
57
-
58
-
And for prefixing css3 properties use [Autoprefixer](https://github.com/ai/autoprefixer)
59
-
```bash
60
-
gem install autoprefixer-rails
61
-
```
62
-
63
-
**Note:** Also you need to install [Node.js](http://nodejs.org/download/)
53
+
**Note:** You need to install [Node.js](http://nodejs.org/download/)
64
54
65
55
To watch changes of `.sass` files and compile it to the `.css` on a fly change property `safe: true` to `safe: false` in `_config.yml`.
66
56
**Note: It works only on local machine, because GitHub runs Jekyll in `--save`[mode](https://help.github.com/articles/using-jekyll-with-pages/#configuration-overrides)**
@@ -70,7 +60,7 @@ Learn more about Sass development from [documentation](https://github.com/gdg-x/
70
60
71
61
### Resource optimizations (optional)
72
62
73
-
You can optimize images and minify css and javascript automaticaly (for now only on Windows).
63
+
You can optimize images and minify css and javascript automatically (for now only on Windows).
74
64
But for Mac OS users available amazing tool - [imageoptim](https://imageoptim.com/). Thanks [@raphaelsavina](https://github.com/raphaelsavina) for link.
75
65
Optimize all images by running this script from `/automation/images/` folder:
76
66
```bash
@@ -87,13 +77,6 @@ Learn more about available optimization options from [documentation](https://git
87
77
### Documentation
88
78
Quick-start guide is not enough? Checkout [full documentation](https://github.com/gdg-x/zeppelin/wiki).
Project is published under the [MIT licence](https://github.com/gdg-x/zeppelin/blob/master/LICENSE.txt). Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)
115
+
### License
116
+
Project is published under the [MIT license](https://github.com/gdg-x/zeppelin/blob/master/LICENSE.txt). Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)
0 commit comments