mirror of
https://github.com/kremalicious/blog.git
synced 2024-11-22 18:00:06 +01:00
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
kremalicious3
|
|
==================
|
|
|
|
> [kremalicious.com](http://kremalicious.com) based on [Jekyll](http://jekyllrb.com). Neat.
|
|
|
|
Requirements
|
|
------------------
|
|
|
|
You need to have the following tools installed on your development machine before moving on:
|
|
|
|
- [node.js](http://nodejs.org/) & [npm](https://npmjs.org/)
|
|
- [Bower](http://bower.io/)
|
|
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/)) and [Bundler](http://bundler.io/)
|
|
|
|
|
|
Get up and running
|
|
------------------
|
|
|
|
For various reasons the assets build process and Jekyll site generation is managed through Grunt instead of `jekyll` or `rake`.
|
|
|
|
Both, `grunt server` and `grunt build`, use [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll) to first generate the site into the `_site` folder and the following Grunt tasks output into that folder.
|
|
|
|
The `media` folder holding the source post images is excluded from Jekyll site generation and rsynced around from `_src/_media` to `_site/media` before site generation starts.
|
|
|
|
Image size generation for post teaser images and photos is done with [jekyll-picture-tag](https://github.com/robwierzbowski/jekyll-picture-tag), putting resized images into `_site/media/gen`.
|
|
|
|
### Install dependencies
|
|
|
|
Run the following command from the repository's root folder to install all dependencies.
|
|
|
|
```bash
|
|
npm install && bower install && bundle install
|
|
```
|
|
|
|
### Development build
|
|
|
|
This generates the site and assets with some Jekyll development options and starts a local dev server combined with a livereloading watch task under `http://localhost:1337`.
|
|
|
|
**[jekyll-picture-tag](https://github.com/robwierzbowski/jekyll-picture-tag) makes site generation very slow at the moment.** During development, uncommenting [some lines](https://github.com/kremalicious/kremalicious3/blob/master/_src/_plugins/picture_tag.rb#L142-L144) in that plugin's file speeds up regeneration dramatically. Seriously, from like 10 min. to 10 sec. Downside: no teaser images or photos in the development build.
|
|
|
|
```bash
|
|
grunt server
|
|
```
|
|
|
|
### Production build
|
|
|
|
Runs almost the same tasks as `grunt server` but cleans the build directory before running Jekyll with some production options and additionally optimizes all image assets.
|
|
|
|
```bash
|
|
grunt build
|
|
```
|