chore(website): here and there improvements

docs/.gitignore

@@ -0,0 +1,2 @@
+_site
+.sass-cache

docs/Gemfile

@@ -0,0 +1,18 @@
+# Ruby Gems for building and testing Bootstrap
+# Run `grunt update-gemfile-lock` to update to the latest compatible versions
+
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'jekyll'
+  gem 'haml'
+  gem 'rouge'
+  gem 'sass'
+  gem 'guard'
+  gem 'nokogiri'
+  gem 'jekyll-contentblocks'
+  gem 'guard-jekyll-plus'
+  gem 'guard-livereload'
+  gem 'guard-bundler', require: false
+  gem 'algoliasearch-jekyll', '~> 0.4.3'
+end

docs/Gemfile.lock

@@ -0,0 +1,140 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    algoliasearch (1.6.1)
+      httpclient (~> 2.4)
+      json (>= 1.5.1)
+    algoliasearch-jekyll (0.4.3)
+      algoliasearch (~> 1.4)
+      awesome_print (~> 1.6)
+      json (~> 1.8)
+      nokogiri (~> 1.6)
+    awesome_print (1.6.1)
+    blankslate (2.1.2.4)
+    classifier-reborn (2.0.3)
+      fast-stemmer (~> 1.0)
+    coderay (1.1.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    colorator (0.1)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.0.8)
+    execjs (2.6.0)
+    fast-stemmer (1.0.2)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-jekyll-plus (2.0.2)
+      guard (~> 2.10, >= 2.10.3)
+      guard-compat (~> 1.1)
+      jekyll (>= 1.0.0)
+    guard-livereload (2.4.0)
+      em-websocket (~> 0.5)
+      guard (~> 2.8)
+      multi_json (~> 1.8)
+    haml (4.0.7)
+      tilt
+    http_parser.rb (0.6.0)
+    httpclient (2.6.0.1)
+    jekyll (2.5.3)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-contentblocks (1.0.1)
+      jekyll
+    jekyll-gist (1.3.4)
+    jekyll-paginate (1.1.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-watch (1.3.0)
+      listen (~> 3.0)
+    json (1.8.3)
+    kramdown (1.9.0)
+    liquid (2.6.3)
+    listen (3.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mercenary (0.3.5)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    nenv (0.2.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.11)
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pygments.rb (0.6.3)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.2.0)
+    rb-fsevent (0.9.6)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.3)
+    rouge (1.7.7)
+    safe_yaml (1.0.4)
+    sass (3.4.19)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    tilt (2.0.1)
+    toml (0.1.2)
+      parslet (~> 1.5.0)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  algoliasearch-jekyll (~> 0.4.3)
+  guard
+  guard-bundler
+  guard-jekyll-plus
+  guard-livereload
+  haml
+  jekyll
+  jekyll-contentblocks
+  nokogiri
+  rouge
+  sass
+
+BUNDLED WITH
+   1.10.6

docs/Guardfile

@@ -0,0 +1,24 @@
+require 'json'
+
+ENV['VERSION'] = JSON.parse(File.read(File.join(File.dirname(__FILE__), '..', 'package.json')))['version']
+
+guard 'jekyll-plus', :serve => true do
+  watch /.*/
+  ignore /^_site/
+end
+
+guard 'livereload', port: '35730' do
+  watch /.*/
+end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end

docs/README.md

@@ -0,0 +1,10 @@
+Instantsearch.js website
+=========================
+
+# Development
+
+```sh
+$ bundle install
+$ bundle exec guard # watch & live-reload
+$ open http://localhost:4000/instantsearch.js/
+```

docs/_config.yml

@@ -0,0 +1,21 @@
+# Site settings
+title: Instantsearch.js
+description: instantsearch.js is a library of widgets to build high performance instant search experiences using Algolia
+baseurl: "/instantsearch.js" # the subpath of your site, e.g. /blog/
+twitter_username: algolia
+github_username: algolia
+
+# Navigation
+navigation:
+ - text: Widgets
+   url: /widgets/
+ - text: Themes
+   url: /themes/
+ - text: About
+   url: /about/
+# Build settings
+markdown: kramdown
+
+# Assets
+sass:
+  sass_dir: css

docs/_includes/footer.html

@@ -0,0 +1,22 @@
+<div class="spacer100 bg-white"></div>
+<footer class="site-footer">
+  <p>
+    Designed and built with <i class="fa fa-heart"></i> by <a href="https://www.algolia.com">Algolia</a><br />
+    Code licensed under <a href="https://github.com/algolia/instantsearch.js/blob/master/LICENSE">MIT</a>
+  </p>
+  <p>
+    <ul class="list-inline">
+      <li>Currently v{{ site.version }}</li>
+      <li>•</li>
+      <li><a href="http://github.com/algolia/instantsearch.js">GitHub</a></li>
+      <li>•</li>
+      <li><a href="http://github.com/algolia/instantsearch.js/issues">Issues</a></li>
+      <li>•</li>
+      <li><a href="http://github.com/algolia/instantsearch.js/releases">Releases</a></li>
+    </ul>
+  </p>
+  <div class="m400 m-l-r-auto">
+    {% include newsletter-mc.html %}
+  </div>
+  <div class="spacer50"></div>
+</footer>

docs/_includes/header.html

@@ -0,0 +1,20 @@
+<header class="site-header">
+
+  <nav class="navbar navbar-default  navbar-inverse">
+    <div class="container-fluid">
+      <div class="navbar-header">
+        <a class="navbar-brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
+      </div>
+
+      <ul class="nav navbar-nav">
+        {% assign url = page.url | remove: 'index.html' %}
+        {% for link in site.navigation %}
+          <li {% if url == link.url %}class="active"{% endif %}>
+            <a href="{{ site.baseurl }}{{ link.url }}" title="{{ link.title }}">{{ link.text }}</a>
+          </li>
+        {% endfor %}
+      </ul>
+    </div>
+  </nav>
+
+</header>

docs/_includes/newsletter-mc.html

@@ -0,0 +1,26 @@
+<!-- Begin MailChimp Signup Form -->
+<link href="//cdn-images.mailchimp.com/embedcode/classic-081711.css" rel="stylesheet" type="text/css">
+<style type="text/css">
+  #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
+  /* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
+     We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
+</style>
+<div id="mc_embed_signup">
+<form action="//algolia.us3.list-manage.com/subscribe/post?u=f7b8acc6ec97794a08484ca9b&amp;id=285b80e148" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
+  <div id="mc_embed_signup_scroll">
+  <h4>Subscribe to our mailing list</h4>
+<div class="mc-field-group">
+  <label for="mce-EMAIL">Email Address </label>
+  <input type="email" value="" name="EMAIL" class="required email" id="mce-EMAIL">
+</div>
+  <div id="mce-responses" class="clear">
+    <div class="response" id="mce-error-response" style="display:none"></div>
+    <div class="response" id="mce-success-response" style="display:none"></div>
+  </div>    <!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
+    <div style="position: absolute; left: -5000px;"><input type="text" name="b_f7b8acc6ec97794a08484ca9b_285b80e148" tabindex="-1" value=""></div>
+    <div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button"></div>
+    </div>
+</form>
+</div>
+<script type='text/javascript' src='//s3.amazonaws.com/downloads.mailchimp.com/js/mc-validate.js'></script><script type='text/javascript'>(function($) {window.fnames = new Array(); window.ftypes = new Array();fnames[0]='EMAIL';ftypes[0]='email';fnames[1]='FNAME';ftypes[1]='text';fnames[2]='LNAME';ftypes[2]='text';fnames[3]='MMERGE3';ftypes[3]='text';}(jQuery));var $mcj = jQuery.noConflict(true);</script>
+<!--End mc_embed_signup-->

docs/_includes/widget-jsdoc/hierarchicalMenu.md

@@ -0,0 +1,24 @@
+| Param | Description |
+| --- | --- |
+|  <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget |
+|  <span class='attr-required'>`options.attributes`</span> | Array of attributes to use to generate the hierarchy of the menu. You need to follow some conventions: |
+|  <span class='attr-optional'>`options.sortBy`</span> | How to sort refinements. Possible values: `count|isRefined|name:asc|desc` |
+|  <span class='attr-optional'>`options.limit`</span> | How much facet values to get |
+|  <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to add to the wrapping elements: root, list, item |
+|  <span class='attr-optional'>`options.cssClasses.root`</span> | CSS class to add to the root element |
+|  <span class='attr-optional'>`options.cssClasses.header`</span> | CSS class to add to the header element |
+|  <span class='attr-optional'>`options.cssClasses.body`</span> | CSS class to add to the body element |
+|  <span class='attr-optional'>`options.cssClasses.footer`</span> | CSS class to add to the footer element |
+|  <span class='attr-optional'>`options.cssClasses.list`</span> | CSS class to add to the list element |
+|  <span class='attr-optional'>`options.cssClasses.item`</span> | CSS class to add to each item element |
+|  <span class='attr-optional'>`options.cssClasses.active`</span> | CSS class to add to each active element |
+|  <span class='attr-optional'>`options.cssClasses.link`</span> | CSS class to add to each link (when using the default template) |
+|  <span class='attr-optional'>`options.cssClasses.count`</span> | CSS class to add to each count element (when using the default template) |
+|  <span class='attr-optional'>`options.templates`</span> | Templates to use for the widget |
+|  <span class='attr-optional'>`options.templates.header`</span> | Header template (root level only) |
+|  <span class='attr-optional'>`options.templates.item`</span> | Item template |
+|  <span class='attr-optional'>`options.templates.footer`</span> | Footer template (root level only) |
+|  <span class='attr-optional'>`options.transformData`</span> | Method to change the object passed to the item template |
+|  <span class='attr-optional'>`options.hideWhenNoResults`</span> | Hide the container when there's no results |
+
+<p class="attr-legend">* <span>Required</span></p>

docs/_includes/widget-jsdoc/hits.md

@@ -0,0 +1,16 @@
+| Param | Description |
+| --- | --- |
+|  <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget |
+|  <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to add |
+|  <span class='attr-optional'>`options.cssClasses.root`</span> | CSS class to add to the wrapping element |
+|  <span class='attr-optional'>`options.cssClasses.empty`</span> | CSS class to add to the wrapping element when no results |
+|  <span class='attr-optional'>`options.cssClasses.item`</span> | CSS class to add to each result |
+|  <span class='attr-optional'>`options.templates`</span> | Templates to use for the widget |
+|  <span class='attr-optional'>`options.templates.empty`</span> | Template to use when there are no results. |
+|  <span class='attr-optional'>`options.templates.item`</span> | Template to use for each result. |
+|  <span class='attr-optional'>`options.transformData`</span> | Method to change the object passed to the templates |
+|  <span class='attr-optional'>`options.transformData.empty`</span> | Method used to change the object passed to the empty template |
+|  <span class='attr-optional'>`options.transformData.item`</span> | Method used to change the object passed to the item template |
+|  <span class='attr-optional'>`options.hitsPerPage`</span> | The number of hits to display per page |
+
+<p class="attr-legend">* <span>Required</span></p>

docs/_includes/widget-jsdoc/indexSelector.md

@@ -0,0 +1,12 @@
+| Param | Description |
+| --- | --- |
+|  <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget |
+|  <span class='attr-required'>`options.indices`</span> | Array of objects defining the different indices to choose from. |
+|  <span class='attr-required'>`options.indices[0].name`</span> | Name of the index to target |
+|  <span class='attr-required'>`options.indices[0].label`</span> | Label displayed in the dropdown |
+|  <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to be added |
+|  <span class='attr-optional'>`options.cssClasses.root`</span> | CSS classes added to the parent <select> |
+|  <span class='attr-optional'>`options.cssClasses.item`</span> | CSS classes added to each <option> |
+|  <span class='attr-optional'>`options.hideWhenNoResults`</span> | Hide the container when no results match |
+
+<p class="attr-legend">* <span>Required</span></p>

docs/_includes/widget-jsdoc/menu.md

@@ -0,0 +1,24 @@
+| Param | Description |
+| --- | --- |
+|  <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget |
+|  <span class='attr-required'>`options.facetName`</span> | Name of the attribute for faceting |
+|  <span class='attr-optional'>`options.sortBy`</span> | How to sort refinements. Possible values: `count|isRefined|name:asc|desc` |
+|  <span class='attr-optional'>`options.limit`</span> | How many facets values to retrieve |
+|  <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to add to the wrapping elements: root, list, item |
+|  <span class='attr-optional'>`options.cssClasses.root`</span> | CSS class to add to the root element |
+|  <span class='attr-optional'>`options.cssClasses.header`</span> | CSS class to add to the header element |
+|  <span class='attr-optional'>`options.cssClasses.body`</span> | CSS class to add to the body element |
+|  <span class='attr-optional'>`options.cssClasses.footer`</span> | CSS class to add to the footer element |
+|  <span class='attr-optional'>`options.cssClasses.list`</span> | CSS class to add to the list element |
+|  <span class='attr-optional'>`options.cssClasses.item`</span> | CSS class to add to each item element |
+|  <span class='attr-optional'>`options.cssClasses.active`</span> | CSS class to add to each active element |
+|  <span class='attr-optional'>`options.cssClasses.link`</span> | CSS class to add to each link (when using the default template) |
+|  <span class='attr-optional'>`options.cssClasses.count`</span> | CSS class to add to each count element (when using the default template) |
+|  <span class='attr-optional'>`options.templates`</span> | Templates to use for the widget |
+|  <span class='attr-optional'>`options.templates.header`</span> | Header template |
+|  <span class='attr-optional'>`options.templates.item`</span> | Item template, provided with `name`, `count`, `isRefined` |
+|  <span class='attr-optional'>`options.templates.footer`</span> | Footer template |
+|  <span class='attr-optional'>`options.transformData`</span> | Method to change the object passed to the item template |
+|  <span class='attr-optional'>`options.hideWhenNoResults`</span> | Hide the container when there's no results |
+
+<p class="attr-legend">* <span>Required</span></p>

docs/_includes/widget-jsdoc/pagination.md

@@ -0,0 +1,25 @@
+| Param | Description |
+| --- | --- |
+|  <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget |
+|  <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to be added |
+|  <span class='attr-optional'>`options.cssClasses.root`</span> | CSS classes added to the parent |
+|  <span class='attr-optional'>`options.cssClasses.item`</span> | CSS classes added to each |
+|  <span class='attr-optional'>`options.cssClasses.page`</span> | CSS classes added to page |
+|  <span class='attr-optional'>`options.cssClasses.previous`</span> | CSS classes added to the previous |
+|  <span class='attr-optional'>`options.cssClasses.next`</span> | CSS classes added to the next |
+|  <span class='attr-optional'>`options.cssClasses.first`</span> | CSS classes added to the first |
+|  <span class='attr-optional'>`options.cssClasses.last`</span> | CSS classes added to the last |
+|  <span class='attr-optional'>`options.cssClasses.active`</span> | CSS classes added to the active |
+|  <span class='attr-optional'>`options.cssClasses.disabled`</span> | CSS classes added to the disabled |
+|  <span class='attr-optional'>`options.labels`</span> | Text to display in the various links (prev, next, first, last) |
+|  <span class='attr-optional'>`options.labels.previous`</span> | Label for the Previous link |
+|  <span class='attr-optional'>`options.labels.next`</span> | Label for the Next link |
+|  <span class='attr-optional'>`options.labels.first`</span> | Label for the First link |
+|  <span class='attr-optional'>`options.labels.last`</span> | Label for the Last link |
+|  <span class='attr-optional'>`options.maxPages`</span> | The max number of pages to browse |
+|  <span class='attr-optional'>`options.padding`</span> | The number of pages to display on each side of the current page |
+|  <span class='attr-optional'>`options.scrollTo`</span> | Where to scroll after a click, set to `false` to disable |
+|  <span class='attr-optional'>`options.showFirstLast`</span> | Define if the First and Last links should be displayed |
+|  <span class='attr-optional'>`options.hideWhenNoResults`</span> | Hide the container when no results match |
+
+<p class="attr-legend">* <span>Required</span></p>