sharpetronics/jekyll-algolia
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adding handling of the sidebar in the documentation

Browse Source
This commit is contained in:
Pixelastic 2017-12-15 18:49:13 +01:00
parent 71ac2c9398
commit 90518a2954
46 changed files with 2978 additions and 205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs-src/lib/.eslintrc.js
View File

@ -1,5 +1,5 @@
module.exports = {
extends: ['../../.eslintrc.js'],
extends: ['../.eslintrc.js'],
rules: {
'import/no-commonjs': 'off'
}

2
docs-src/lib/middlewares.js
View File

@ -4,7 +4,6 @@ const msWebpack = require('ms-webpack');
const sass = require('metalsmith-sass');
const cleanCSS = require('metalsmith-clean-css');
const assets = require('./plugins/assets.js');
const helpers = require('./plugins/helpers.js');
const ignore = require('./plugins/ignore.js');
const sidebarMenu = require('./plugins/sidebar-menu.js');
const markdown = require('./plugins/markdown.js');
@ -15,7 +14,6 @@ const webpackStartConfig = require('../webpack.config.start.js');
const webpackBuildConfig = require('../webpack.config.build.js');
const common = [
helpers,
assets({
source: './src/assets',
destination: 'assets',

4
docs-src/lib/plugins/helpers.js
View File

@ -1,13 +1,9 @@
const highlight = require('./syntaxHighlighting.js');
const md = require('./mdRenderer.js');
// this plugin provides ATM one helper to easily compute the publicPath of assets
module.exports = function helpers(filenames, metalsmith, cb) {
// eslint-disable-next-line no-param-reassign
metalsmith.metadata().h = {
markdown(src) {
return md.render(src);
},
highlight(src, opts) {
const lang = opts && opts.lang;
return highlight(src, lang);

52
docs-src/lib/plugins/markdown.js
View File

@ -1,21 +1,47 @@
/* eslint-disable no-param-reassign */
const path = require('path');
const md = require('./mdRenderer');
const _ = require('lodash');
const MarkdownIt = require('markdown-it');
const markdownItAnchor = require('markdown-it-anchor');
const highlight = require('./syntaxHighlighting.js');
const md = new MarkdownIt('default', {
highlight: (str, lang) => highlight(str, lang),
linkify: true,
typographer: true,
html: true,
}).use(markdownItAnchor, {
permalink: true,
permalinkClass: 'anchor',
permalinkSymbol: '',
// generate proper Getting_started.html#install hrefs since we are
// using the base href trick to handle different base urls (dev, prod)
permalinkHref: (slug, state) => `${state.env.path}#${slug}`,
});
const isMarkdown = filepath => /\.md|\.markdown/.test(path.extname(filepath));
module.exports = function markdown(files, metalsmith, done) {
Object.keys(files).forEach(file => {
if (!isMarkdown(file)) return;
const data = files[file];
const dir = path.dirname(file);
let html = `${path.basename(file, path.extname(file))}.html`;
if (dir !== '.') html = `${dir}/${html}`;
const str = md.render(data.contents.toString(), { path: html });
data.contents = new Buffer(str);
// eslint-disable-next-line no-param-reassign
delete files[file];
// eslint-disable-next-line no-param-reassign
files[html] = data;
_.each(files, (data, filepath) => {
// We keep all non-markdown files as-is
if (!isMarkdown(filepath)) {
return;
}
// We convert markdown path to html path
const dirname = path.dirname(filepath);
let htmlpath = `${path.basename(filepath, path.extname(filepath))}.html`;
if (dirname !== '.') {
htmlpath = `${dirname}/${htmlpath}`;
}
// We convert the markdown content to HTML
const content = md.render(data.contents.toString(), { path: htmlpath });
delete files[filepath];
files[htmlpath] = {
...data,
contents: new Buffer(content),
};
});
done();

19
docs-src/lib/plugins/mdRenderer.js
View File

@ -1,19 +0,0 @@
const MarkdownIt = require('markdown-it');
const markdownItAnchor = require('markdown-it-anchor');
const highlight = require('./syntaxHighlighting.js');
const md = new MarkdownIt('default', {
highlight: (str, lang) => highlight(str, lang),
linkify: true,
typographer: true,
html: true,
}).use(markdownItAnchor, {
permalink: true,
permalinkClass: 'anchor',
permalinkSymbol: '',
// generate proper Getting_started.html#install hrefs since we are
// using the base href trick to handle different base urls (dev, prod)
permalinkHref: (slug, { env: { path } }) => `${path}#${slug}`,
});
module.exports = md;

78
docs-src/lib/plugins/sidebar-menu.js
View File

@ -1,52 +1,40 @@
/* eslint-disable no-param-reassign */
const _ = require('lodash');
const config = require('../../config');
module.exports = function() {
// All the pages accessible from the menu
let pagesInMenu = [];
_.each(config.sidebarMenu, category => {
pagesInMenu = _.concat(pagesInMenu, _.map(category.items, 'url'));
});
return function(files, metalsmith, done) {
// _.each(files, (data, path) => {
// data.githubSource = config.sidebarMenu;
// });
_.each(files, (data, path) => {
// Skip files that are not in the menu, they don't need a menu
if (!_.includes(pagesInMenu, path)) {
return;
}
// Overriding the global sidebarMenu var with one with more info on
// subchild
const sidebarMenu = _.cloneDeep(config.sidebarMenu);
_.each(sidebarMenu, category => {
_.each(category.items, item => {
// Looping until we find the menu entry
if (item.url !== path) return;
item.isActive = true;
// Adding a subchild entry
item.items = _.map(data.headings, heading => ({
title: heading.text,
url: `${path}#${heading.id}`,
}));
});
});
data.sidebarMenu = sidebarMenu;
});
done();
// const categories = {};
// // First we scann all the HTML files to retrieve all the related documents based
// // on the category attribute in the metadata
// forEach(files, (data, path) => {
// if (!path.match(/\.html$/) || data.tocVisibility === false) return;
// const category = data.category || 'other';
// categories[category] = categories[category] || [];
// categories[category].push({
// path,
// title: data.title,
// navWeight: data.navWeight,
// metadata: data,
// });
// });
// for (let categoryName in categories) {
// categories[categoryName] = categories[categoryName].sort((a, b) => {
// if (a.title && b.title && a.navWeight === b.navWeight) {
// return a.title.localeCompare(b.title);
// } else {
// return a.navWeight - b.navWeight;
// }
// });
// }
// // Then we go through all the files again to attach in the navigation attribute
// // all the related documents
// forEach(files, (data, path) => {
// if (!path.match(/\.html$/)) return;
// const category = data.category || 'other';
// data.essentials = categories['Getting started'];
// data.advanced = categories['Advanced'];
// data.examples = categories['Examples'];
// data.components = categories['Components'];
// data.navPath = path;
// });
// done();
};
}
};

38
docs-src/lib/plugins/syntaxHighlighting.js
View File

@ -1,28 +1,30 @@
const { runMode } = require('codemirror/addon/runmode/runmode.node');
require('codemirror/mode/shell/shell');
require('codemirror/mode/jsx/jsx');
require('codemirror/mode/htmlmixed/htmlmixed');
require('codemirror/mode/css/css');
require('codemirror/mode/htmlmixed/htmlmixed');
require('codemirror/mode/jsx/jsx');
require('codemirror/mode/ruby/ruby');
require('codemirror/mode/shell/shell');
require('codemirror/mode/yaml/yaml');
const escape = require('escape-html');
module.exports = function highlight(source, lang) {
module.exports = function highlight(source, languageCode) {
let tokenizedSource = '';
let newLang = lang;
if (newLang === 'html') {
newLang = 'htmlmixed';
}
if (newLang === 'js') {
newLang = 'jsx';
}
if (newLang === 'shell') {
newLang = 'shell';
}
// eslint-disable-next-line no-unused-var
const codeType = newLang === 'shell' ? 'Command' : 'Code';
const languageMapping = {
html: 'htmlmixed',
js: 'jsx',
json: 'jsx',
shell: 'shell',
yaml: 'yaml',
yml: 'yaml',
ruby: 'ruby',
};
const languageParser = languageMapping[languageCode];
const codeType = languageParser === 'shell' ? 'Command' : 'Code';
// this is a synchronous callback API
runMode(source, newLang, (text, style) => {
runMode(source, languageParser, (text, style) => {
const escapedText = escape(text);
if (!style) {
@ -36,7 +38,7 @@ module.exports = function highlight(source, lang) {
});
return `<pre class="code-sample cm-s-mdn-like codeMirror ${
newLang
languageParser
}" data-code-type="${codeType}"><div class="code-wrap"><code>${
tokenizedSource
}</code></div></pre>`;

19
docs-src/lib/serve.js
View File

@ -16,22 +16,17 @@ builder({ middlewares }, err => {
// then we watch and rebuild
chokidar
.watch(
[
path.join(__dirname, '../src/**/*'),
],
{
ignoreInitial: true,
ignored: /assets\/js\/(.*)?\.js$/,
}
)
.on('all', () =>
.watch([path.join(__dirname, '../src/**/*')], {
ignoreInitial: true,
ignored: /assets\/js\/(.*)?\.js$/,
})
.on('all', () => {
builder({ clean: false, middlewares }, err => {
if (err) {
throw err;
}
})
)
});
})
.on('error', err => {
throw err;
});

11
docs-src/package.json
View File

@ -4,8 +4,7 @@
"version": "1.0.0",
"scripts": {
"serve": "./scripts/serve",
"build": "./scripts/build",
"postinstall": "./scripts/postinstall"
"build": "./scripts/build"
},
"devDependencies": {
"@babel/core": "7.0.0-beta.34",
@ -61,10 +60,10 @@
"stat-mode": "0.2.2",
"style-loader": "0.19.0",
"uglifyjs-webpack-plugin": "1.1.2",
"vdom-to-html": "^2.3.1",
"webpack": "3.10.0",
"webpack-dev-middleware": "1.12.2",
"webpack-hot-middleware": "2.21.0",
"tachyons-algolia": "^0.3.18"
"webpack-hot-middleware": "2.21.0"
},
"engines": {
"node": "^9.2.0",
@ -81,7 +80,9 @@
":timezone(Europe/Paris)"
]
},
"workspaces": ["src/*"],
"workspaces": [
"src/*"
],
"license": "MIT",
"author": "Algolia, Inc. (https://www.algolia.com)"
}

10
docs-src/scripts/postinstall
View File

@ -1,10 +0,0 @@
#!/usr/bin/env sh
mkdir -p ./src/stylesheets/vendors/tachyons-algolia/
cp \
./node_modules/tachyons-algolia/build/* \
./src/stylesheets/vendors/tachyons-algolia
cp \
./node_modules/tachyons-algolia/build/fonts/* \
./src/assets/fonts

11
docs-src/src/assets/js/main.js
View File

@ -1,3 +1,7 @@
import {
repositionSidebarOnScroll,
updateReadLinkOnScroll,
} from './sidebar.js';
import activateClipboard from './activateClipboard.js';
import alg from 'algolia-frontend-components/javascripts.js';
import './editThisPage.js';
@ -16,5 +20,8 @@ const container = document.querySelector('.documentation-container');
const codeSamples = document.querySelectorAll('.code-sample');
activateClipboard(codeSamples);
// eslint-disable-next-line no-console
console.log('Welcome to main page');
if (document.querySelector('.sidebar')) {
repositionSidebarOnScroll();
updateReadLinkOnScroll();
}

71
docs-src/src/assets/js/sidebar.js Normal file
View File

@ -0,0 +1,71 @@
import _ from 'lodash';
export function repositionSidebarOnScroll() {
const documentationContainer = document.querySelector(
'.documentation-container'
);
const sidebar = document.querySelector('.sidebar');
const headerHeight = document
.querySelector('.algc-navigation')
.getBoundingClientRect().height;
// Reposition the sidebar if we scroll down too far so it does not bleed on
// the footer
function __repositionSidebar() {
const boundingBox = documentationContainer.getBoundingClientRect();
const scrollFromTop = window.pageYOffset;
const visibleArea = window.innerHeight - headerHeight;
const documentationContentHeight = boundingBox.height;
const lowerBoundary = documentationContentHeight - visibleArea;
// When we scroll too far below, we fix the position of the sidebar
if (scrollFromTop >= lowerBoundary) {
sidebar.classList.remove('sidebar_fixed');
sidebar.classList.add('sidebar_absolute');
return;
}
sidebar.classList.remove('sidebar_absolute');
sidebar.classList.add('sidebar_fixed');
}
window.addEventListener('load', __repositionSidebar);
document.addEventListener('DOMContentLoaded', __repositionSidebar);
document.addEventListener('scroll', __repositionSidebar);
}
// Mark with an active class the subchild that is currently being read
export function updateReadLinkOnScroll() {
const links = document.querySelectorAll('.sidebar ul ul a');
const titles = document.querySelectorAll('.documentation-container h2');
const headerHeight = document
.querySelector('.algc-navigation')
.getBoundingClientRect().height;
function __updateReadLinkOnScroll() {
// Finding the current read title
let currentTitle = titles[0];
_.each(titles, title => {
const boundingBox = title.getBoundingClientRect();
const titleHeight = boundingBox.height;
const titleTop = boundingBox.top;
const visibleArea = window.innerHeight - headerHeight;
if (titleTop < headerHeight + titleHeight) currentTitle = title;
if (titleTop >= visibleArea + titleHeight) return;
});
// Marking active the link that matches this header
let anchor = currentTitle.getAttribute('id');
_.each(links, link => {
link.classList.remove('sidebar-element_active');
if (_.includes(link.getAttribute('href'), anchor)) {
link.classList.add('sidebar-element_active');
}
});
}
window.addEventListener('load', __updateReadLinkOnScroll);
document.addEventListener('DOMContentLoaded', __updateReadLinkOnScroll);
document.addEventListener('scroll', __updateReadLinkOnScroll);
}

2
docs-src/src/commandline.md
View File

@ -10,7 +10,7 @@ they do. Includes ENV variables as well.
## Command line
## Arguments
Here is the list of command line options you can pass to the `jekyll algolia
push` command:

6
docs-src/src/getting-started.md
View File

@ -7,8 +7,8 @@ layout: content-with-menu.pug
## Welcome to jekyll-algolia
`jekyll-algolia` is a Jekyll plugin that lets you index all your content to
Algolia, to make it searchable by typing `jekyll algolia`.
`jekyll-algolia` is a Jekyll plugin that lets you index all your content in an
Algolia index.
## Requirements
@ -73,6 +73,8 @@ write access to your index so will be able to push new data. This is also why
you have to set it on the command line and not in the `_config.yml` file: you
want to keep this key secret and not commit it to your versioning system.
<script type="text/javascript" src="https://asciinema.org/a/VQw3ofNmGXjYs11tneq49PBVc.js" id="asciicast-VQw3ofNmGXjYs11tneq49PBVc" async></script>
_Note that the method can be simplified to `jekyll algolia` by using an
[alternative way][6] of loading the API key and using [rubygems-bundler][7]._

48
docs-src/src/how-it-works.md
View File

@ -3,7 +3,7 @@ title: How does this work?
layout: content-with-menu.pug
---
## How does this work?
# How does this work?
The plugin will work like a `jekyll build` run, but instead of writing `.html`
files to disk, it will push content to Algolia. It will go through each file
@ -14,11 +14,44 @@ Instead, it will split each page into small chunks (by default, one per
`<p>` paragraph) and then push each chunk as a new record to Algolia. Splitting
records that way allows for a more fine-tuned relevance even on long pages.
Each record created that way will contain a mix of specific data and shared
data. Specific data will be the paragraph content, and information about its
position in the page (where its situated in the hierarchy of headings in the
page). Shared data is the metadata of the page it was extracted from (`slug`,
`url`, `tags`, etc, as well as any custom field added to the front-matter).
Here is an example of what a record looks like:
```json
{
"objectID": "e2dd8dd1eaaf961baa6da4de309628e9",
"title": "New experimental version of Hacker News Search built with Algolia",
"type": "post",
"url": "/2015/01/12/try-new-experimental-version-hn-search.html",
"draft": false,
"layout": "post",
"ext": ".md",
"date": 1421017200,
"excerpt_html": "<p>Exactly a year ago, we began to power […]</p>",
"excerpt_text": "Exactly a year ago, we began to power […]",
"slug": "try-new-experimental-version-hn-search",
"html": "<p>We've learned a lot from your comments […]</p>",
"text": "We've learned a lot from your comments […]",
"tag_name": "p",
"hierarchy": {
"lvl0": null,
"lvl1": "Applying more UI best practices",
"lvl2": "Focus on readability",
},
"anchor": "focus-on-readability",
"weight": {
"position": 8,
"heading": 70
}
}
```
Each record created that way will contain a mix of shared data and specific
data. Shared data is the metadata of the page it was extracted from (`title`,
`slug`, `url`, `tags`, etc, as well as any custom field added to the
front-matter). Specific data is the paragraph content, and information
about its position in the page (where its situated in the hierarchy of headings
in the page).
Once displayed, results are grouped so only the best matching paragraph of each
page is returned for a specific query. This greatly improves the perceived
@ -29,3 +62,6 @@ an estimate of how many records will actually be pushed. The plugin tries to be
smart and consume as less operations as possible, but you can always run it in
`--dry-run` mode to better understand what it would do.
<div class="m-l-r-auto">
<script type="text/javascript" src="https://asciinema.org/a/FSuwJWRZR3g7S5JUYg8nySwXe.js" id="asciicast-FSuwJWRZR3g7S5JUYg8nySwXe" async></script>
</div>

16
docs-src/src/layouts/content-with-menu.pug
View File

@ -2,15 +2,21 @@ extends ./common/meta.pug
block body
section.documentation-section
.container
nav.sidebar.pos-abt.z-100
.container.relative
nav.sidebar.z-100.sidebar_fixed
.sidebar-container
each category in sidebarMenu
h2.sidebar-header.text-bold=category['title']
h2.sidebar-header.text-bold=category.title
ul.sidebar-elements
each item in category['items']
each item in category.items
li.sidebar-element
a(href=item['url'])=item['title']
- var className = item.isActive ? 'sidebar-element_active': '';
a(href=item.url class=className)=item.title
if item.items
ul
each subitem in item.items
li.sidebar-element
a(href=subitem.url)=subitem.title
a.sidebar-opener
.documentation-container

12
docs-src/src/options.md
View File

@ -12,7 +12,7 @@ section of your `_config.yml` file.
You should be familiar with [how this plugin works][1] under
the hood to better understand what some options are doing.
### `extensions_to_index`
## `extensions_to_index`
This options defines which source files should be indexed, based on their file
extension. If an extension is not in the list, then the file will not be
@ -29,7 +29,7 @@ algolia:
extensions_to_index: 'html,md,adoc,textile'
```
### `files_to_exclude`
## `files_to_exclude`
This option lets you define a blacklist of source files you don't want to index.
@ -62,7 +62,7 @@ algolia:
_Note that some files (pagination pages, static assets, etc) will **always** be
excluded and you don't have to specify them._
### `nodes_to_index`
## `nodes_to_index`
This options defines how each page is split into chunks. It expects
a CSS selector that will be applied on the HTML content generated by Jekyll.
@ -80,13 +80,13 @@ algolia:
nodes_to_index: 'p,blockquote,li,div.paragraph'
```
### `indexing_mode`
## `indexing_mode`
This option will let you choose the strategy used to sync your data with your
Algolia index. The default value should work for most cases, but feel free to
[read the pros and cons][4] of each and pick the one best suited for your needs.
### `settings`
## `settings`
This option let you pass specific settings to your Algolia index.
@ -105,7 +105,7 @@ algolia:
highlightPostTag: '</em>'
```
### `indexing_batch_size`
## `indexing_batch_size`
The Algolia API allows you to send batches of changes to add or update several
records at once, instead of doing one HTTP call per record. The plugin will

24
docs-src/src/stylesheets/components/_documentation.scss
View File

@ -1,5 +1,5 @@
$sidebar-width: 260px;
$offset-height: 60px;
$offset-height: 64px;
.documentation-section,
.examples-section {
@ -30,6 +30,10 @@ $offset-height: 60px;
h2,h3,h4 {
color: $bunting; }
h1 {
padding-bottom: 16px;
}
h2:not(.text-lg) {
font-size: 28px;
padding-right: 1em;
@ -46,6 +50,14 @@ $offset-height: 60px;
@include small-mq {
font-size: 22px; } }
// Scroll anchors into view
h2:target:before {
content: "";
display: block;
height: $offset-height;
}
h3 {
font-size: 24px;
color: #201c38;
@ -195,17 +207,11 @@ $offset-height: 60px;
+ pre {
margin-bottom: 2em; } }
h2, h3, .api-entry, .css-class, .type {
&:before {
content: "";
display: block;
height: $offset-height;
} } // margin: (-$offset-height) 0 0
.anchor {
margin-left: .2em;
display: inline;
visibility: hidden; }
visibility: hidden;
}
h2, h3, .api-entry {
.anchor {

22
docs-src/src/stylesheets/components/_sidebar.scss
View File

@ -2,14 +2,25 @@ $sidebarTopOffset: 60px;
.sidebar {
width: $sidebar-width;
// height: 100vh;
height: calc(100vh - #{$sidebarTopOffset});
margin-top: 0;
// margin-top: $sidebarTopOffset
padding-top: $sidebarTopOffset;
padding-top: 60px;
padding-bottom: 30px;
overflow-y: auto;
overflow-x: visible;
// Default sidebar position
&.sidebar_fixed {
position: fixed;
}
// Added when we scroll down too far
&.sidebar_absolute {
position: absolute;
bottom: 0;
}
.sidebar-container {
margin-bottom: 20px;
@ -17,10 +28,6 @@ $sidebarTopOffset: 60px;
font-size: 17px;
margin-bottom: 0; } }
&.fixed {
position: fixed;
top: $sidebarTopOffset; }
ul {
list-style: none;
padding: 0;
@ -57,12 +64,9 @@ $sidebarTopOffset: 60px;
&:hover {
text-decoration: underline; }
&.navItem-active {
&.sidebar-element_active {
color: #00A7FF;
font-weight: 600;
transform: translateX(0px);
transition: transform .2s ease;
&:before {
opacity: 1; } } } }

4
docs-src/src/stylesheets/index.scss
View File

@ -28,4 +28,6 @@
-moz-osx-font-smoothing: grayscale; }
.debug * { outline: 1px solid gold; }
.absolute { position: absolute; }
.relative { position: relative; }
.fixed { position: fixed; }

30
docs-src/src/support.md
View File

@ -3,6 +3,32 @@ title: ⚡ Support
layout: single-column.pug
---
# Support
```json
{
"objectID": "e2dd8dd1eaaf961baa6da4de309628e9",
"title": "New experimental version of Hacker News Search built with Algolia",
"type": "post",
"url": "/2015/01/12/try-new-experimental-version-hn-search.html",
"draft": false,
"layout": "post",
"ext": ".md",
"date": 1421017200,
"excerpt_html": "<p>Exactly a year ago, we began to power […]</p>",
"excerpt_text": "Exactly a year ago, we began to power […]",
"slug": "try-new-experimental-version-hn-search",
Hello
"html": "<p>We've learned a lot from your comments […]</p>",
"text": "We've learned a lot from your comments […]",
"tag_name": "p",
"hierarchy": {
"lvl0": null,
"lvl1": "Applying more UI best practices",
"lvl2": "Focus on readability",
},
"anchor": "focus-on-readability",
"weight": {
"position": 8,
"heading": 70
}
}
```

115
docs-src/yarn.lock
View File

@ -787,6 +787,16 @@ asap@~2.0.3:
version "2.0.6"
resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46"
asciicast-to-svg@derhuerst/asciicast-to-svg:
version "0.2.1"
resolved "https://codeload.github.com/derhuerst/asciicast-to-svg/tar.gz/2083fa53640cdb318140ac65cc64977cc5d685c6"
dependencies:
headless-terminal "^0.4.0"
minimist "^1.2.0"
screen-buffer "^0.4.0"
vdom-to-html "^2.3.1"
virtual-dom "^2.1.1"
asn1.js@^4.0.0:
version "4.9.2"
resolved "https://registry.yarnpkg.com/asn1.js/-/asn1.js-4.9.2.tgz#8117ef4f7ed87cd8f89044b5bff97ac243a16c9a"
@ -1577,6 +1587,10 @@ brorand@^1.0.1:
version "1.1.0"
resolved "https://registry.yarnpkg.com/brorand/-/brorand-1.1.0.tgz#12c25efe40a45e3c323eb8675a0a0ce57b22371f"
browser-split@0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/browser-split/-/browser-split-0.0.1.tgz#7b097574f8e3ead606fb4664e64adfdda2981a93"
browser-sync-client@2.5.1:
version "2.5.1"
resolved "https://registry.yarnpkg.com/browser-sync-client/-/browser-sync-client-2.5.1.tgz#ec1ad69a49c2e2d4b645b18b1c06c29b3d9af8eb"
@ -1779,6 +1793,10 @@ camelcase@^4.0.0, camelcase@^4.1.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-4.1.0.tgz#d545635be1e33c542649c69173e5de6acfae34dd"
camelize@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/camelize/-/camelize-1.0.0.tgz#164a5483e630fa4321e5af07020e531831b2609b"
caniuse-api@^1.5.2:
version "1.6.1"
resolved "https://registry.yarnpkg.com/caniuse-api/-/caniuse-api-1.6.1.tgz#b534e7c734c4f81ec5fbe8aca2ad24354b962c6c"
@ -2867,6 +2885,14 @@ error-stack-parser@^1.3.6:
dependencies:
stackframe "^0.3.1"
error@^4.3.0:
version "4.4.0"
resolved "https://registry.yarnpkg.com/error/-/error-4.4.0.tgz#bf69ff251fb4a279c19adccdaa6b61e90d9bf12a"
dependencies:
camelize "^1.0.0"
string-template "~0.2.0"
xtend "~4.0.0"
es-abstract@^1.7.0:
version "1.10.0"
resolved "https://registry.yarnpkg.com/es-abstract/-/es-abstract-1.10.0.tgz#1ecb36c197842a00d8ee4c2dfd8646bb97d60864"
@ -2941,7 +2967,7 @@ es6-weak-map@^2.0.1:
es6-iterator "^2.0.1"
es6-symbol "^3.1.1"
escape-html@1.0.3, escape-html@~1.0.3:
escape-html@1.0.3, escape-html@^1.0.1, escape-html@~1.0.3:
version "1.0.3"
resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
@ -3093,6 +3119,12 @@ etag@^1.7.0, etag@~1.8.0, etag@~1.8.1:
version "1.8.1"
resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887"
ev-store@^7.0.0:
version "7.0.0"
resolved "https://registry.yarnpkg.com/ev-store/-/ev-store-7.0.0.tgz#1ab0c7f82136505dd74b31d17701cb2be6d26558"
dependencies:
individual "^3.0.0"
event-emitter@~0.3.5:
version "0.3.5"
resolved "https://registry.yarnpkg.com/event-emitter/-/event-emitter-0.3.5.tgz#df8c69eef1647923c7157b9ce83840610b02cc39"
@ -3830,6 +3862,12 @@ he@^1.1.1:
version "1.1.1"
resolved "https://registry.yarnpkg.com/he/-/he-1.1.1.tgz#93410fd21b009735151f8868c2f271f3427e23fd"
headless-terminal@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/headless-terminal/-/headless-terminal-0.4.0.tgz#790f37a3ea5c2af33e9f65451db6e14362c4050e"
dependencies:
vt "~0.1.1"
hmac-drbg@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/hmac-drbg/-/hmac-drbg-1.0.1.tgz#d2745701025a6c775a6c545793ed502fc0c649a1"
@ -4047,6 +4085,10 @@ indexof@0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/indexof/-/indexof-0.0.1.tgz#82dc336d232b9062179d05ab3293a66059fd435d"
individual@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/individual/-/individual-3.0.0.tgz#e7ca4f85f8957b018734f285750dc22ec2f9862d"
inflight@^1.0.4:
version "1.0.6"
resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9"
@ -4274,6 +4316,10 @@ is-obj@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f"
is-object@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/is-object/-/is-object-1.0.1.tgz#8952688c5ec2ffd6b03ecc85e769e02903083470"
is-path-cwd@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/is-path-cwd/-/is-path-cwd-1.0.0.tgz#d225ec23132e89edd38fda767472e62e65f1106d"
@ -4785,6 +4831,10 @@ loud-rejection@^1.0.0:
currently-unhandled "^0.4.1"
signal-exit "^3.0.0"
lower-case@^1.1.1:
version "1.1.4"
resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-1.1.4.tgz#9a2cabd1b9e8e0ae993a4bf7d5875c39c42e8eac"
lowercase-keys@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-1.0.0.tgz#4e3366b39e7f5457e35f1324bdf6f88d0bfc7306"
@ -5165,6 +5215,10 @@ negotiator@0.6.1:
version "0.6.1"
resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.1.tgz#2b327184e8992101177b28563fb5e7102acd0ca9"
next-tick@^0.2.2:
version "0.2.2"
resolved "https://registry.yarnpkg.com/next-tick/-/next-tick-0.2.2.tgz#75da4a927ee5887e39065880065b7336413b310d"
node-fetch@^1.0.1:
version "1.7.3"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.7.3.tgz#980f6f72d85211a5347c6b2bc18c5b84c3eb47ef"
@ -5533,6 +5587,12 @@ parallel-transform@^1.1.0:
inherits "^2.0.3"
readable-stream "^2.1.5"
param-case@^1.0.1:
version "1.1.2"
resolved "https://registry.yarnpkg.com/param-case/-/param-case-1.1.2.tgz#dcb091a43c259b9228f1c341e7b6a44ea0bf9743"
dependencies:
sentence-case "^1.1.2"
parse-asn1@^5.0.0:
version "5.1.0"
resolved "https://registry.yarnpkg.com/parse-asn1/-/parse-asn1-5.1.0.tgz#37c4f9b7ed3ab65c74817b5f2480937fbf97c712"
@ -6808,6 +6868,10 @@ schema-utils@^0.3.0:
dependencies:
ajv "^5.0.0"
screen-buffer@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/screen-buffer/-/screen-buffer-0.4.0.tgz#9d8bc177a385839afd590d8fbd1277bc731db004"
scss-tokenizer@^0.2.3:
version "0.2.3"
resolved "https://registry.yarnpkg.com/scss-tokenizer/-/scss-tokenizer-0.2.3.tgz#8eb06db9a9723333824d3f5530641149847ce5d1"
@ -6879,6 +6943,12 @@ send@0.16.1:
range-parser "~1.2.0"
statuses "~1.3.1"
sentence-case@^1.1.2:
version "1.1.3"
resolved "https://registry.yarnpkg.com/sentence-case/-/sentence-case-1.1.3.tgz#8034aafc2145772d3abe1509aa42c9e1042dc139"
dependencies:
lower-case "^1.1.1"
serialize-error@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/serialize-error/-/serialize-error-2.1.0.tgz#50b679d5635cdf84667bdc8e59af4e5b81d5f60a"
@ -7241,6 +7311,10 @@ strict-uri-encode@^1.0.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/strict-uri-encode/-/strict-uri-encode-1.1.0.tgz#279b225df1d582b1f54e65addd4352e18faa0713"
string-template@~0.2.0:
version "0.2.1"
resolved "https://registry.yarnpkg.com/string-template/-/string-template-0.2.1.tgz#42932e598a352d01fc22ec3367d9d84eec6c9add"
string-width@^1.0.1, string-width@^1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3"
@ -7378,10 +7452,6 @@ table@^4.0.1:
slice-ansi "1.0.0"
string-width "^2.1.1"
tachyons-algolia@^0.3.18:
version "0.3.18"
resolved "https://registry.yarnpkg.com/tachyons-algolia/-/tachyons-algolia-0.3.18.tgz#ca4087aa41774f90bc9a88a78303eff4c2dda7bd"
tapable@^0.2.7, tapable@~0.2.5:
version "0.2.8"
resolved "https://registry.yarnpkg.com/tapable/-/tapable-0.2.8.tgz#99372a5c999bf2df160afc0d74bed4f47948cd22"
@ -7862,6 +7932,14 @@ vary@~1.1.2:
version "1.1.2"
resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc"
vdom-to-html@^2.3.1:
version "2.3.1"
resolved "https://registry.yarnpkg.com/vdom-to-html/-/vdom-to-html-2.3.1.tgz#14762673676d1b9cfb3f18d7eb566f527546519d"
dependencies:
escape-html "^1.0.1"
param-case "^1.0.1"
xtend "^4.0.0"
vendors@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/vendors/-/vendors-1.0.1.tgz#37ad73c8ee417fb3d580e785312307d274847f22"
@ -7882,6 +7960,19 @@ vfile@^1.0.0:
version "1.4.0"
resolved "https://registry.yarnpkg.com/vfile/-/vfile-1.4.0.tgz#c0fd6fa484f8debdb771f68c31ed75d88da97fe7"
virtual-dom@^2.1.1:
version "2.1.1"
resolved "https://registry.yarnpkg.com/virtual-dom/-/virtual-dom-2.1.1.tgz#80eda2d481b9ede0c049118cefcb4a05f21d1375"
dependencies:
browser-split "0.0.1"
error "^4.3.0"
ev-store "^7.0.0"
global "^4.3.0"
is-object "^1.0.1"
next-tick "^0.2.2"
x-is-array "0.1.0"
x-is-string "0.1.0"
vm-browserify@0.0.4:
version "0.0.4"
resolved "https://registry.yarnpkg.com/vm-browserify/-/vm-browserify-0.0.4.tgz#5d7ea45bbef9e4a6ff65f95438e0a87c357d5a73"
@ -7892,6 +7983,10 @@ void-elements@^2.0.1:
version "2.0.1"
resolved "https://registry.yarnpkg.com/void-elements/-/void-elements-2.0.1.tgz#c066afb582bb1cb4128d60ea92392e94d5e9dbec"
vt@~0.1.1:
version "0.1.1"
resolved "https://registry.yarnpkg.com/vt/-/vt-0.1.1.tgz#8aa1265f2b9519cd4aaacbd794ce248871a10921"
ware@^1.2.0:
version "1.3.0"
resolved "https://registry.yarnpkg.com/ware/-/ware-1.3.0.tgz#d1b14f39d2e2cb4ab8c4098f756fe4b164e473d4"
@ -8160,6 +8255,14 @@ wtf-8@1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/wtf-8/-/wtf-8-1.0.0.tgz#392d8ba2d0f1c34d1ee2d630f15d0efb68e1048a"
x-is-array@0.1.0:
version "0.1.0"
resolved "https://registry.yarnpkg.com/x-is-array/-/x-is-array-0.1.0.tgz#de520171d47b3f416f5587d629b89d26b12dc29d"
x-is-string@0.1.0:
version "0.1.0"
resolved "https://registry.yarnpkg.com/x-is-string/-/x-is-string-0.1.0.tgz#474b50865af3a49a9c4657f05acd145458f77d82"
xdg-basedir@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-3.0.0.tgz#496b2cc109eca8dbacfe2dc72b603c17c5870ad4"
@ -8168,7 +8271,7 @@ xmlhttprequest-ssl@1.5.3:
version "1.5.3"
resolved "https://registry.yarnpkg.com/xmlhttprequest-ssl/-/xmlhttprequest-ssl-1.5.3.tgz#185a888c04eca46c3e4070d99f7b49de3528992d"
xtend@^4.0.0, xtend@^4.0.1, xtend@~4.0.1:
xtend@^4.0.0, xtend@^4.0.1, xtend@~4.0.0, xtend@~4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.1.tgz#a5c6d532be656e23db820efb943a1f04998d63af"

6
docs/about.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-c12955b28d4250747947bb1d7410440f.css"></head><body><div><!-- Start community header -->
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-8594b359718befe431b00dcffa06ce3e.css"></head><body><div><!-- Start community header -->
<nav class='algc-navigation'>
<div class='algc-navigation__container'>
<div class='algc-mainmenu'>
@ -62,7 +62,7 @@
</li>
<li class="algc-menu__list__item ">
<a href="documentation.html" class="">
<a href="options.html" class="">
Documentation
</a>
@ -193,4 +193,4 @@
</nav>
<!-- End community_header --> </div><div class="spacer64"></div><div class="content"><h1 id="about">About <a class="anchor" href="about.html#about" aria-hidden="true"></a></h1>
<p>Hello</p>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-2e52a029a618101927525e0c95a37964.js"></script><script src="/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js"></script></html>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js"></script><script src="/js/main-build-4983729fe216fdd682ba1eb196a6d483.js"></script></html>

197
docs/autocomplete.html Normal file
View File

File diff suppressed because one or more lines are too long

198
docs/blog.html Normal file
View File

File diff suppressed because one or more lines are too long

198
docs/collections.html Normal file
View File

File diff suppressed because one or more lines are too long

273
docs/commandline.html Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/data/communityHeader-f38d8440331a54b56d141ef98d236148.json → docs/data/communityHeader-8eefec952ebb9c0e0b3dd19e8efa6888.json
View File

@ -61,7 +61,7 @@
},
{
"name": "Documentation",
"url": "documentation.html"
"url": "options.html"
},
{
"name": "Examples",

199
docs/examples.html Normal file
View File

File diff suppressed because one or more lines are too long

60
docs/getting-started.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-c12955b28d4250747947bb1d7410440f.css"></head><body><div><!-- Start community header -->
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-8594b359718befe431b00dcffa06ce3e.css"></head><body><div><!-- Start community header -->
<nav class='algc-navigation'>
<div class='algc-navigation__container'>
<div class='algc-mainmenu'>
@ -62,7 +62,7 @@
</li>
<li class="algc-menu__list__item ">
<a href="documentation.html" class="">
<a href="options.html" class="">
Documentation
</a>
@ -191,6 +191,56 @@
</li></ul></div></div>
</nav>
<!-- End community_header --> </div><div class="spacer64"></div><section class="documentation-section debug"><div class="container"><nav class="sidebar pos-abt z-100"><div class="sidebar-container"><h2 class="sidebar-header">Essentials</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="getting-started.html">Getting Started</a></li><li class="sidebar-element"><a href="how-it-works.html">How it works</a></li></ul></div><div class="sidebar-container"><h2 class="sidebar-header">Configuration</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="options.html">Options</a></li><li class="sidebar-element"><a href="commandline.html">Commandline</a></li><li class="sidebar-element"><a href="hooks.html">Hooks</a></li></ul></div><div class="sidebar-container"><h2 class="sidebar-header">Advanced</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="github-pages.html">Github Pages</a></li><li class="sidebar-element"><a href="netlify.html">Netlify</a></li><li class="sidebar-element"><a href="travis.html">Travis</a></li></ul></div><div class="sidebar-container"><h2 class="sidebar-header">Examples</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="autocomplete.html">Autocomplete</a></li><li class="sidebar-element"><a href="instantsearch.html">InstantSearch</a></li></ul></div><!-- div.sidebar-container--><!-- h2.sidebar-header=title--><!-- ul.sidebar-elements--><!-- if navItems--><!-- if navItems.length === 1--><!-- +navContent(headings, 0, currentPath)--><!-- else--><!-- +navRec(currentPath, navItems, title, 2, headings)--></nav><a class="sidebar-opener"></a><div class="documentation-container"><h1 id="getting-started">Getting started <a class="anchor" href="getting-started.html#getting-started" aria-hidden="true"></a></h1>
<p>Hello</p>
</div></div></section></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-2e52a029a618101927525e0c95a37964.js"></script><script src="/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js"></script></html>
<!-- End community_header --> </div><div class="spacer64"></div><section class="documentation-section"><div class="container"><nav class="sidebar z-100 fixed"><div class="sidebar-container"><h2 class="sidebar-header text-bold">Essentials</h2><ul class="sidebar-elements"><li class="sidebar-element"><a class="sidebar-element_active" href="getting-started.html">Getting Started</a><ul><li class="sidebar-element"><a href="getting-started.html#welcome-to-jekyll-algolia">Welcome to jekyll-algolia </a></li><li class="sidebar-element"><a href="getting-started.html#requirements">Requirements </a></li><li class="sidebar-element"><a href="getting-started.html#installation">Installation </a></li><li class="sidebar-element"><a href="getting-started.html#configuration">Configuration </a></li><li class="sidebar-element"><a href="getting-started.html#usage">Usage </a></li></ul></li><li class="sidebar-element"><a href="how-it-works.html">How it works</a></li></ul><h2 class="sidebar-header text-bold">Configuration</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="options.html">Options</a></li><li class="sidebar-element"><a href="commandline.html">Commandline</a></li><li class="sidebar-element"><a href="hooks.html">Hooks</a></li><li class="sidebar-element"><a href="indexing-modes.html">Indexing modes</a></li></ul><h2 class="sidebar-header text-bold">Advanced</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="netlify.html">Deploying on Netlify</a></li><li class="sidebar-element"><a href="github-pages.html">Deploying on Github Pages</a></li></ul><h2 class="sidebar-header text-bold">Examples</h2><ul class="sidebar-elements"><li class="sidebar-element"><a href="blog.html">Blog</a></li><li class="sidebar-element"><a href="autocomplete.html">Dropdown menu</a></li><li class="sidebar-element"><a href="collections.html">Collection search</a></li></ul></div></nav><a class="sidebar-opener"></a><div class="documentation-container"><h1 id="getting-started">Getting started <a class="anchor" href="getting-started.html#getting-started" aria-hidden="true"></a></h1>
<h2 id="welcome-to-jekyll-algolia">Welcome to jekyll-algolia <a class="anchor" href="getting-started.html#welcome-to-jekyll-algolia" aria-hidden="true"></a></h2>
<p><code>jekyll-algolia</code> is a Jekyll plugin that lets you index all your content in an
Algolia index.</p>
<h2 id="requirements">Requirements <a class="anchor" href="getting-started.html#requirements" aria-hidden="true"></a></h2>
<p>You’ll need:</p>
<ul>
<li><a href="https://jekyllrb.com/">Jekyll</a> &gt;= 3.6.0</li>
<li><a href="https://www.ruby-lang.org/en/">Ruby</a> &gt;= 2.3.0</li>
<li><a href="http://bundler.io/">Bundler</a></li>
</ul>
<h2 id="installation">Installation <a class="anchor" href="getting-started.html#installation" aria-hidden="true"></a></h2>
<p>You need to add <code>jekyll-algolia</code> to your <code>Gemfile</code>, as part of the
<code>:jekyll-plugins</code> group. If you do not yet have a Gemfile, here is the minimal
content you’ll need:</p>
<pre class="code-sample cm-s-mdn-like codeMirror ruby" data-code-type="Code"><div class="code-wrap"><code><span class="cm-variable">source</span> <span class="cm-string">&#39;https://rubygems.org&#39;</span>
<span class="cm-variable">gem</span> <span class="cm-string">&#39;jekyll&#39;</span>, <span class="cm-string">&#39;~&gt; 3.6&#39;</span>
<span class="cm-variable">group</span> <span class="cm-atom">:jekyll_plugins</span> <span class="cm-keyword">do</span>
<span class="cm-variable">gem</span> <span class="cm-string">&#39;jekyll-algolia&#39;</span>
<span class="cm-keyword">end</span>
</code></div></pre>
<p>Then, run <code>bundle install</code> to update your dependencies.</p>
<p>If everything went well, you should be able to run <code>jekyll help</code> and see the
<code>algolia</code> subcommand listed.</p>
<h2 id="configuration">Configuration <a class="anchor" href="getting-started.html#configuration" aria-hidden="true"></a></h2>
<p>You need to provide your Algolia credentials for this plugin to <em>index</em> your
site.</p>
<p><em>If you don’t yet have an Algolia account, you can open a free <a href="https://www.algolia.com/users/sign_up/hacker">Community plan
here</a>. Once signed in, you can get your credentials from
<a href="https://www.algolia.com/licensing">your dashboard</a>.</em></p>
<p>Once you have your credentials, you should define your <code>application_id</code> and
<code>index_name</code> inside your <code>_config.yml</code> file like this:</p>
<pre class="code-sample cm-s-mdn-like codeMirror yaml" data-code-type="Code"><div class="code-wrap"><code><span class="cm-comment"># _config.yml</span>
<span class="cm-atom">algolia</span><span class="cm-meta">:</span>
<span class="cm-atom"> application_id</span><span class="cm-meta">: </span><span class="cm-string">&#39;your_application_id&#39;</span>
<span class="cm-atom"> index_name</span><span class="cm-meta">: </span><span class="cm-string">&#39;your_index_name&#39;</span>
</code></div></pre>
<h2 id="usage">Usage <a class="anchor" href="getting-started.html#usage" aria-hidden="true"></a></h2>
<p>Once your credentials are setup, you can run the indexing by running the
following command:</p>
<pre class="code-sample cm-s-mdn-like codeMirror shell" data-code-type="Command"><div class="code-wrap"><code><span class="cm-def">ALGOLIA_API_KEY</span><span class="cm-operator">=</span><span class="cm-string">&#39;{your_admin_api_key}&#39;</span> bundle exec jekyll algolia
</code></div></pre>
<p>Note that <code>ALGOLIA_API_KEY</code> should be set to your admin API key. This key has
write access to your index so will be able to push new data. This is also why
you have to set it on the command line and not in the <code>_config.yml</code> file: you
want to keep this key secret and not commit it to your versioning system.</p>
<script type="text/javascript" src="https://asciinema.org/a/VQw3ofNmGXjYs11tneq49PBVc.js" id="asciicast-VQw3ofNmGXjYs11tneq49PBVc" async></script>
<p><em>Note that the method can be simplified to <code>jekyll algolia</code> by using an
<a href="./commandline.html#algolia-api-key-file">alternative way</a> of loading the API key and using <a href="https://github.com/rvm/rubygems-bundler">rubygems-bundler</a>.</em></p>
</div></div></section></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js"></script><script src="/js/main-build-4983729fe216fdd682ba1eb196a6d483.js"></script></html>

243
docs/github-pages.html Normal file
View File

File diff suppressed because one or more lines are too long

204
docs/hooks.html Normal file
View File

File diff suppressed because one or more lines are too long

247
docs/how-it-works.html Normal file
View File

File diff suppressed because one or more lines are too long

6
docs/index.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-c12955b28d4250747947bb1d7410440f.css"></head><body><div><!-- Start community header -->
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-8594b359718befe431b00dcffa06ce3e.css"></head><body><div><!-- Start community header -->
<nav class='algc-navigation'>
<div class='algc-navigation__container'>
<div class='algc-mainmenu'>
@ -62,7 +62,7 @@
</li>
<li class="algc-menu__list__item ">
<a href="documentation.html" class="">
<a href="options.html" class="">
Documentation
</a>
@ -193,4 +193,4 @@
</nav>
<!-- End community_header --> </div><div class="spacer64"></div><div class="content"><h1 id="homepage">Homepage <a class="anchor" href="index.html#homepage" aria-hidden="true"></a></h1>
<p>Hello you!</p>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-2e52a029a618101927525e0c95a37964.js"></script><script src="/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js"></script></html>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js"></script><script src="/js/main-build-4983729fe216fdd682ba1eb196a6d483.js"></script></html>

229
docs/indexing-modes.html Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/js/common-build-2e52a029a618101927525e0c95a37964.js → docs/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js
View File

File diff suppressed because one or more lines are too long

2
docs/js/common-build-2e52a029a618101927525e0c95a37964.js.map → docs/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js.map
View File

File diff suppressed because one or more lines are too long

2
docs/js/main-build-4983729fe216fdd682ba1eb196a6d483.js Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/js/main-build-4983729fe216fdd682ba1eb196a6d483.js.map Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js
View File

File diff suppressed because one or more lines are too long

1
docs/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js.map
View File

File diff suppressed because one or more lines are too long

196
docs/netlify.html Normal file
View File

File diff suppressed because one or more lines are too long

273
docs/options.html Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/stylesheets/index-c12955b28d4250747947bb1d7410440f.css → docs/stylesheets/index-8594b359718befe431b00dcffa06ce3e.css
View File

File diff suppressed because one or more lines are too long

8
docs/stylesheets/index-c12955b28d4250747947bb1d7410440f.css.map → docs/stylesheets/index-8594b359718befe431b00dcffa06ce3e.css.map
View File

File diff suppressed because one or more lines are too long

36
docs/support.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-c12955b28d4250747947bb1d7410440f.css"></head><body><div><!-- Start community header -->
<!DOCTYPE html><html lang="en"><head><base href="/"><meta content="IE=edge" http-equiv="X-UA-Compatible"><meta charset="utf-8"><meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"><meta name="ROBOTS" content="NOINDEX, NOFOLLOW"><link rel="icon" href="assets/images/favicon-ce4df27f133f483500b0ea0fbf5171e1.png"><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"><meta content="Jekyll plugin to automatically index your content on Algolia." name="description"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><!-- Twitter card--><meta content="summary_large_image" name="twitter:card"><meta content="https://community.algolia.com/jekyll-algolia/" name="twitter:site"><meta content="Algolia" name="twitter:creator"><meta content="Algolia for Jekyll" name="twitter:title"><meta content="Search your Jekyll content with Algolia" name="twitter:description"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" name="twitter:image"><!-- OG meta--><meta content="https://community.algolia.com/jekyll-algolia/" property="og:url"><meta content="Algolia for Jekyll" property="og:title"><meta content="https://res.cloudinary.com/hilnmyskv/image/upload/v1502375309/InstantSearch-React-OG_zbf1tb.png" property="og:image"><meta content="website" property="og:type"><meta content="Search your Jekyll content with Algolia" property="og:description"><meta content="Algolia for Jekyll" property="og:site_name"><title>Algolia for Jekyll | Search your Jekyll content with Algolia</title><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="stylesheets/index-8594b359718befe431b00dcffa06ce3e.css"></head><body><div><!-- Start community header -->
<nav class='algc-navigation'>
<div class='algc-navigation__container'>
<div class='algc-mainmenu'>
@ -62,7 +62,7 @@
</li>
<li class="algc-menu__list__item ">
<a href="documentation.html" class="">
<a href="options.html" class="">
Documentation
</a>
@ -191,6 +191,32 @@
</li></ul></div></div>
</nav>
<!-- End community_header --> </div><div class="spacer64"></div><div class="content"><h1 id="support">Support <a class="anchor" href="support.html#support" aria-hidden="true"></a></h1>
<p>Hello</p>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-2e52a029a618101927525e0c95a37964.js"></script><script src="/js/main-build-cb83ac2c8dc59cb9e24ef062140b314d.js"></script></html>
<!-- End community_header --> </div><div class="spacer64"></div><div class="content"><pre class="code-sample cm-s-mdn-like codeMirror jsx" data-code-type="Code"><div class="code-wrap"><code>{
<span class="cm-string">&quot;objectID&quot;</span>: <span class="cm-string">&quot;e2dd8dd1eaaf961baa6da4de309628e9&quot;</span>,
<span class="cm-string">&quot;title&quot;</span>: <span class="cm-string">&quot;New experimental version of Hacker News Search built with Algolia&quot;</span>,
<span class="cm-string">&quot;type&quot;</span>: <span class="cm-string">&quot;post&quot;</span>,
<span class="cm-string">&quot;url&quot;</span>: <span class="cm-string">&quot;/2015/01/12/try-new-experimental-version-hn-search.html&quot;</span>,
<span class="cm-string">&quot;draft&quot;</span>: <span class="cm-atom">false</span>,
<span class="cm-string">&quot;layout&quot;</span>: <span class="cm-string">&quot;post&quot;</span>,
<span class="cm-string">&quot;ext&quot;</span>: <span class="cm-string">&quot;.md&quot;</span>,
<span class="cm-string">&quot;date&quot;</span>: <span class="cm-number">1421017200</span>,
<span class="cm-string">&quot;excerpt_html&quot;</span>: <span class="cm-string">&quot;&lt;p&gt;Exactly a year ago, we began to power […]&lt;/p&gt;&quot;</span>,
<span class="cm-string">&quot;excerpt_text&quot;</span>: <span class="cm-string">&quot;Exactly a year ago, we began to power […]&quot;</span>,
<span class="cm-string">&quot;slug&quot;</span>: <span class="cm-string">&quot;try-new-experimental-version-hn-search&quot;</span>,
<span class="cm-string">&quot;html&quot;</span>: <span class="cm-string">&quot;&lt;p&gt;We&#39;ve learned a lot from your comments […]&lt;/p&gt;&quot;</span>,
<span class="cm-string">&quot;text&quot;</span>: <span class="cm-string">&quot;We&#39;ve learned a lot from your comments […]&quot;</span>,
<span class="cm-string">&quot;tag_name&quot;</span>: <span class="cm-string">&quot;p&quot;</span>,
<span class="cm-string">&quot;hierarchy&quot;</span>: {
<span class="cm-string">&quot;lvl0&quot;</span>: <span class="cm-atom">null</span>,
<span class="cm-string">&quot;lvl1&quot;</span>: <span class="cm-string">&quot;Applying more UI best practices&quot;</span>,
<span class="cm-string">&quot;lvl2&quot;</span>: <span class="cm-string">&quot;Focus on readability&quot;</span>,
},
<span class="cm-string">&quot;anchor&quot;</span>: <span class="cm-string">&quot;focus-on-readability&quot;</span>,
<span class="cm-string">&quot;weight&quot;</span>: {
<span class="cm-string">&quot;position&quot;</span>: <span class="cm-number">8</span>,
<span class="cm-string">&quot;heading&quot;</span>: <span class="cm-number">70</span>
}
}
</code></div></pre>
</div></body><section class="footer-new-cta footer-new h300 pos-rel"><div class="container color-white stellar-container vh-center"><div class="col-md-5"><div class="spacer120 hidden-sm"></div><div class="spacer32 visible-xs"></div><header><h2 class="text-normal m-t-none">Start creating stellar search,<span class="cf hidden-xs"></span>no strings attached.</h2><p>Dive into Algolia with our 14-day trial - No credit card required. Plenty of time to see how Algolia can change your business.</p></header></div><div class="col-md-7 pos-rel z-10"><div class="spacer120 inline hidden-sm"></div><div class="spacer32 inline hidden-sm"></div><div class="spacer16 visible-sm"></div><div class="button-holder h200 p-r-large"><div class="spacer16 hidden-md hidden-sm"></div><span class="inline pos-rel"><a class="btn btn-static-primary btn-static-shadow-dark" href="https://algolia.com/users/sign_up">Get Started<svg class="arrow-icon" width="22"><use xlink:href="#arrow-right"></use></svg></a><svg class="search-icon" width="22"><use xlink:href="#search-icon"></use></svg></span></div></div></div></section><div id="footer"><div class="credits"><div class="container pos-rel"><div class="row"><div class="col-md-12 text-center"><a data-no-turbolink="true" href="/"><img width="40" src="https://www.algolia.com/static_assets/images/flat2/algolia/algolia-logo_badge-598a1fe6.svg"></a></div></div><div class="spacer40"></div></div></div></div><svg style="display: none;"><symbol width="40" height="40" viewbox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" id="search-icon"><path d="M26.806 29.012a16.312 16.312 0 0 1-10.427 3.746C7.33 32.758 0 25.425 0 16.378 0 7.334 7.333 0 16.38 0c9.045 0 16.378 7.333 16.378 16.38 0 3.96-1.406 7.593-3.746 10.426L39.547 37.34c.607.608.61 1.59-.004 2.203a1.56 1.56 0 0 1-2.202.004L26.808 29.012zm-10.427.627c7.32 0 13.26-5.94 13.26-13.26 0-7.325-5.94-13.26-13.26-13.26-7.325 0-13.26 5.935-13.26 13.26 0 7.32 5.935 13.26 13.26 13.26z" fill-rule="evenodd"></path></symbol><symbol width="46" height="38" viewbox="0 0 46 38" xmlns="http://www.w3.org/2000/svg" id="arrow-right"><path d="M34.852 15.725l-8.624-9.908L24.385 3.7 28.62.014l1.84 2.116 13.1 15.05 1.606 1.846-1.61 1.844-13.1 15.002-1.845 2.114-4.23-3.692 1.85-2.114 9.465-10.84h-24.66v-5.615h23.817zm-26.774 0h-.002 2.96v5.614H0v-5.615h8.078z" fill-rule="evenodd"></path></symbol><symbol xmlns="http://www.w3.org/2000/svg" viewbox="0 0 708.8 717" id="icon-copy"><path d="M658.8 158H490.2c-13.3 0-26 5.3-35.4 14.6l-4.6 4.6V25c0-13.8-11.2-25-25-25H235.6c-6.6 0-13 2.6-17.7 7.3L7.3 218C2.6 222.6 0 229 0 235.6V541c0 13.8 11.2 25 25 25h227.8v101c0 27.6 22.4 50 50 50h356c27.6 0 50-22.4 50-50V208c0-27.6-22.4-50-50-50zm-204 85.4V360H338.2l116.6-116.6zm-253-149.2V209H87L201.8 94.2zM50 516V259h176.8c13.8 0 25-11.2 25-25V50h148.4v177.3L267.5 360c-9.4 9.4-14.6 22.1-14.6 35.4V516H50zm608.8 151h-356V410h177c13.8 0 25-11.2 25-25V208h154v459z"></path></symbol><symbol id="check-icon" viewbox="0 0 33 26"><path d="M32.57872 2.63298L30.2617.31596c-.38617-.38617-1.01808-.38617-1.40425 0l-18.1851 18.20266-6.4947-6.49468c-.38616-.38617-1.01808-.38617-1.40425 0L.45638 14.34096c-.38617.38617-.38617 1.01808 0 1.40425l7.17926 7.17928 2.31702 2.31702c.38617.38616 1.01808.38616 1.40425 0l2.3346-2.29948 18.8872-18.9048c.38617-.38616.38617-1.01807 0-1.40424z" fill-rule="evenodd"></path></symbol></svg><!--Google Tag Manager--><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-N8JP8G" height="0" width="0" style="display:none;visibility:hidden;"></iframe></noscript><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-N8JP8G');</script><script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="/js/common-build-fabcd803f85c8b5fd1c6b4c454554bf4.js"></script><script src="/js/main-build-4983729fe216fdd682ba1eb196a6d483.js"></script></html>