README.md in jekyll-zopfli-1.1.0 vs README.md in jekyll-zopfli-2.0.0
- old
+ new
@@ -1,41 +1,95 @@
# Jekyll::Zopfli
Generate gzipped assets and files for your Jekyll site at build time using [Zopfli](https://github.com/google/zopfli) compression.
-[](https://travis-ci.org/philnash/jekyll-zopfli)
+[](https://rubygems.org/gems/jekyll-zopfli) [](https://travis-ci.org/philnash/jekyll-zopfli) [](https://codeclimate.com/github/philnash/jekyll-zopfli/maintainability) [](https://inch-ci.org/github/philnash/jekyll-zopfli)
+[API docs](http://www.rubydoc.info/gems/jekyll-zopfli/) | [GitHub repo](https://github.com/philnash/jekyll-zopfli)
+
+## Why?
+
Performance in web applications is important. You know that, which is why you have created a static site using Jekyll. But you want a bit more performance. You're serving your assets and files gzipped, but you're making your webserver do it?
Why not just generate those gzip files at build time? And with Google's Zopfli algorithm, which generates files that are 3-8% smaller than Zlib's maximum compression?
`Jekyll::Zopfli` does just that. Add the gem to your Jekyll application and when you build your site it will generate gzip files for all text based files (HTML, CSS, JavaScript, etc).
### Warning
Zopfli is a much slower algorithm than Zlib, so this will likely significantly slow down your site build. If you still want to generate gzip files at build time with a faster build time and Zlib's compression level, check out [`Jekyll::Gzip`](https://github.com/philnash/jekyll-gzip).
+### Want even more compression?
+
+Zopfli is about the best compression we can get out of the gzip format, but there's more! [Brotli](https://en.wikipedia.org/wiki/Brotli) is a relatively new compression format that is now [supported by many browsers](https://caniuse.com/#search=brotli) and can produce even smaller files. You can use brotli compression alongside gzip in your Sinatra app with [`Jekyll::Brotli`](http://github.com/philnash/jekyll-brotli).
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'jekyll-zopfli'
+group :jekyll_plugins do
+ gem 'jekyll-zopfli'
+end
```
And then execute:
```
bundle install
```
+Then add the plugin to the `plugins` key in your `_config.yml`
+
+```yml
+plugins:
+ - jekyll-zopfli
+```
+
## Usage
-Once you have the gem installed, run `JEKYLL_ENV=production bundle exec jekyll build`. In your destination directory (`_site` by default) you will find gzipped files.
+Once you have the gem installed, build your Jekyll site in production mode. On Mac/Linux you can run
-Due to the time it takes to generate zopfli files, this plugin only works when the `JEKYLL_ENV` environment variable is set to `production`.
+```bash
+JEKYLL_ENV=production bundle exec jekyll build
+```
+On Windows, set the `JEKYLL_ENV` environment variable to `"production"`. Check out [this blog post on setting environment variables on Windows](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). Then run:
+
+```bash
+bundle exec jekyll build
+```
+
+In your destination directory (`_site` by default) you will find gzipped versions of all your text files.
+
+`Jekyll::Zopfli` only runs when the environment variable `JEKYLL_ENV` is set to `production` as dealing with gzipping files is unnecessary in development mode and just slows down the site build.
+
+### Configuration
+
+By default, `Jekyll::Zopfli` will compress all files with the following extensions:
+
+- '.html'
+- '.css'
+- '.js'
+- '.txt'
+- '.ttf'
+- '.atom'
+- '.stl'
+- '.xml'
+- '.svg'
+- '.eot'
+
+You can supply your own extensions by adding a `zopfli` key to your site's `_config.yml` listing the extensions that you want to compress. For example to only compress HTML, CSS and JavaScript files, add the following to `_config.yml`:
+
+```yml
+zopfli:
+ extensions:
+ - '.html'
+ - '.css'
+ - '.js
+```
+
### Serving pre-compiled gzip files
You will likely need to adjust your web server config to serve these precomputed gzip files. See below for common server configurations:
#### nginx
@@ -46,12 +100,23 @@
gzip_static on;
```
The `ngx_http_gzip_static_module` module is not built by default, so you may need to enable using the `--with-http_gzip_static_module` configuration parameter.
+#### Apache
+
+In either a `<Directory>` section in your Apache config or in an `.htaccess` file, add the following:
+
+```
+AddEncoding gzip .gz
+RewriteCond %{HTTP:Accept-encoding} gzip
+RewriteCond %{REQUEST_FILENAME}.gz -f
+RewriteRule ^(.*)$ $1.gz [QSA,L]
+```
+
#### Other web servers
-TODO: instructions for other web servers like Apache, HAProxy, etc.
+TODO: instructions for other web servers like HAProxy, h2o etc.
Do you know how to do this for a different server? Please open a [pull request](https://github.com/philnash/jekyll-zopfli/pulls) or an [issue](https://github.com/philnash/jekyll-zopfli/issues) with the details!
## Development