Update middleman config

Signed-off-by: Pierre-Alexandre Meyer <[email protected]>

README.md

@@ -2,27 +2,32 @@
 
 Kill Bill API documentation.
 
-## Setup
+## Edit and Syntax
+
+The documentation is in the `source/includes` directory.
+
+Markdown syntax: https://github.com/slatedocs/slate/wiki/Markdown-Syntax
 
-The pages are built using middleman:
+## Deployment
+
+The site is built using [Middleman](https://github.com/middleman/middleman):
 
 ```
-bundle install
-bundle exec middleman server
+middleman build
 ```
 
-See also https://github.com/slatedocs/slate and https://github.com/middleman/middleman.
+See also https://github.com/slatedocs/slate.
 
-## Edit and Syntax
+Notes:
 
-The documentation is in the `source/includes` directory.
-
-Markdown syntax: https://github.com/slatedocs/slate/wiki/Markdown-Syntax
+* The generated static pages under `build` are deployed by Cloudflare
+* The built pages are also pushed to the `gh-pages` branch for debugging (served by GitHub pages at https://killbill.github.io/slate/)
+* Minification of assets is handled by Cloudflare (check-in the unminified version)
 
-## Publishing
+## Development
 
-In order to publish the doc on github pages, simply run
+To run the site locally:
 
 ```
-./deploy.sh
+middleman server
 ```

config.rb

@@ -41,16 +41,13 @@
 
 # Build Configuration
 configure :build do
-  # We do want to hash woff and woff2 as there's a bug where woff2 will use
-  # woff asset hash which breaks things. Trying to use a combination of ignore and
-  # rewrite_ignore does not work as it conflicts weirdly with relative_assets. Disabling
-  # the .woff2 extension only does not work as .woff will still activate it so have to
-  # have both. See https://github.com/slatedocs/slate/issues/1171 for more details.
-  activate :asset_hash, :exts => app.config[:asset_extensions] - %w[.woff .woff2]
-  # If you're having trouble with Middleman hanging, commenting
-  # out the following two lines has been known to help
-  activate :minify_css
-  activate :minify_javascript
+  # Could cause issues where cached HTML points to stale files not deployed anymore
+  # activate :asset_hash, :exts => app.config[:asset_extensions] - %w[.woff .woff2]
+
+  # Done by Cloudflare
+  # activate :minify_css
+  # activate :minify_javascript
+
   # activate :gzip
 end