From c60a38deadcb98da2e4c9a572e48940d95be1733 Mon Sep 17 00:00:00 2001 From: Scott Severance Date: Fri, 3 Jun 2016 13:04:50 -0500 Subject: [PATCH] Clarify usage instructions. Fixes #15. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 6823ba5..bf0ea8a 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,31 @@ For example, this will disable minification, regardless of your `env` setting. minify_html: false ``` +### Example Configuration + +1. In `_config.yml`, insert: + + ```yaml + minify_html: false + ``` + +2. In a new config file, `_config_production.yml`, insert: + + ```yaml + minify_html: true + ``` +3. In development, build Jekyll normally: + + ```shell + jekyll build # or jekyll serve + ``` + For a production build, run: + + ```shell + jekyll build --config _config.yml,_config_production.yml + ``` + + ## HtmlPress Configuration: You can set configuration options for [HtmlPress](https://github.com/stereobooster/html_press) in your Jekyll configuration like this: