m/blog
1
0
Fork 0
mirror of https://github.com/kremalicious/blog.git synced 2024-11-22 18:00:06 +01:00
Code

update readme

Browse Source
This commit is contained in:
Matthias Kretschmann 2015-06-07 00:38:38 +02:00
parent 275422a5b3
commit 3b6336a8e5
2 changed files with 5 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -31,13 +31,6 @@ Link | `rake link -- Title`
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 build task copies everything over into the `_build`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
@ -49,20 +42,18 @@ npm 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.
This generates the site and assets and starts a local dev server combined with a livereloading watch task under `http://localhost:1337`.
```bash
grunt server
gulp server
```
### Production build
Runs almost the same tasks as `grunt server` but puts everything into the `_build` directory, versions all assets and optimizes all image assets.
Runs almost the same tasks as `gulp server` but additionally versions all assets and optimizes all image assets.
```bash
grunt build
gulp build
```

3
package.json
View File

@ -24,10 +24,9 @@
"gulp-concat": ">=2.5.2",
"gulp-connect": ">=2.0.5",
"gulp-cssmin": ">=0.1.7",
"gulp-header": "^1.2.2",
"gulp-header": ">=1.2.2",
"gulp-imagemin": ">=2.2.1",
"gulp-load-plugins": ">=0.10.0",
"gulp-minify-html": "^1.0.3",
"gulp-rename": ">=1.2.2",
"gulp-rev": ">=4.0.0",
"gulp-rev-replace": ">=0.4.1",