Merge pull request #1427 from segmentio/DOC_131-Algolia

Doc 131 algolia

Author: markzegarelli

Gemfile

@@ -17,6 +17,7 @@ group :jekyll_plugins do
   gem 'jekyll-redirect-from'
   gem "premonition", "~> 2.0.0"
   gem "jekyll-include-cache"
+  gem 'jekyll-algolia'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -23,6 +23,12 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    algolia_html_extractor (2.6.4)
+      json (~> 2.0)
+      nokogiri (~> 1.10)
+    algoliasearch (1.27.5)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
     colorator (1.1.0)
     commonmarker (0.21.0)
       ruby-enum (~> 0.5)
@@ -36,10 +42,21 @@ GEM
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
     ffi (1.13.1)
+    filesize (0.2.0)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
+    httpclient (2.8.3)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    jekyll-algolia (1.6.0)
+      algolia_html_extractor (~> 2.6)
+      algoliasearch (~> 1.26)
+      filesize (~> 0.1)
+      jekyll (>= 3.6, < 5.0)
+      json (~> 2.0)
+      nokogiri (~> 1.6)
+      progressbar (~> 1.9)
+      verbal_expressions (~> 0.1.5)
     jekyll-commonmark (1.3.1)
       commonmarker (~> 0.14)
       jekyll (>= 3.7, < 5.0)
@@ -56,6 +73,7 @@ GEM
       jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    json (2.5.1)
     kramdown (2.3.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -67,12 +85,20 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
+    mini_portile2 (2.5.0)
     multipart-post (2.1.1)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     posix-spawn (0.3.15)
     premonition (2.0.1)
+    progressbar (1.11.0)
     public_suffix (4.0.6)
+    racc (1.5.2)
     rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
@@ -93,6 +119,7 @@ GEM
     tzinfo-data (1.2020.4)
       tzinfo (>= 1.0.0)
     unicode-display_width (1.7.0)
+    verbal_expressions (0.1.5)
     wdm (0.1.1)
 
 PLATFORMS
@@ -103,6 +130,7 @@ DEPENDENCIES
   dotenv
   faraday
   jekyll!
+  jekyll-algolia
   jekyll-commonmark
   jekyll-include-cache
   jekyll-last-modified-at

_config.yml

@@ -49,3 +49,8 @@ plugins:
   - premonition
   - jekyll-commonmark
   - jekyll-last-modified-at
+algolia:
+  application_id: UINQ2M4D9S
+  index_name:     segment-docs
+  files_to_exclude:
+    - _release_notes/*

js/algolia/index.js

@@ -0,0 +1,80 @@
+import { html } from 'htm/preact';
+import algoliasearch from 'algoliasearch/lite';
+import { autocomplete, getAlgoliaHits, highlightHit } from '@algolia/autocomplete-js';
+import {createAlgoliaInsightsPlugin} from '@algolia/autocomplete-plugin-algolia-insights';
+import insightsClient from 'search-insights';
+
+
+const appId = 'UINQ2M4D9S';
+const apiKey = '636b6d9e2dfb207e89ea7344859848f9';
+const searchClient = algoliasearch(appId, apiKey);
+
+//insights
+insightsClient('init', { appId, apiKey });
+const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({ insightsClient });
+
+
+const search = autocomplete({
+  container: '#autocomplete',
+  placeholder: 'Search the Segment documentation',
+  debug: false,
+  openOnFocus: false,
+  keyboardShortcuts: ['s', 191],
+  plugins: [algoliaInsightsPlugin,],
+  detachedMediaQuery:'none',
+  getSources( {query} ) {
+    return [
+      {
+        sourceId: 'articles',
+        getItemUrl({ item }){
+          if (item.anchor != null) {
+            var itemUrl = item.url+"#" + item.anchor;
+          } else {
+            var itemUrl = item.url;
+          }
+          return itemUrl;
+        },
+        getItems() {
+          return getAlgoliaHits({
+            searchClient,
+            queries: [
+              {
+                indexName: 'segment-docs',
+                query,
+                params: {
+                  hitsPerPage: 7,
+                  facetFilters: ['hidden:-true'],
+                  clickAnalytics: true,
+                },
+              },
+            ],
+          });
+        },
+        templates: {
+          item({ item }){
+            if (item.anchor != null) {
+              var anchorLink = "#" + item.anchor;
+            } else {
+              var anchorLink = "";
+            }
+            return html `<a class="aa-link" href="/docs${item.url}${anchorLink}">
+            <p class="aa-title" >${highlightHit({hit: item, attribute: 'title'})}</h3>
+            <p class="aa-heading">${item.headings.join(' >')}</p>
+            <p class="aa-content">${highlightHit({hit: item, attribute: 'content'})}</p></a>
+          `;
+          },
+          noResults() {
+            return html `<p class="aa-content">No results for <strong>${query}</strong></p>`;
+          }
+        },
+        
+      },
+    ];
+  },
+  navigator: {
+    navigate({ itemUrl }) {
+      window.location.assign('/docs'+itemUrl);
+    },
+  }
+});
+

js/index.js

@@ -19,6 +19,7 @@ import sideMenu from './side-menu'
 import tracking from './tracking'
 import searchBar from './search-bar'
 import glightbox from './glightbox'
+import autocomplete from './algolia'
 feedback()
 accordion()
 accordionGroup()
@@ -39,4 +40,4 @@ relativeLinks()
 sideMenu()
 tracking()
 searchBar()
-glightbox()
+glightbox()

netlify.toml

@@ -1,9 +1,13 @@
 [build]
+  command = "jekyll algolia && yarn develop"
   # Ignore builds unless [netlify-build] is present in commit message
   # ignore = "git log -1 --pretty=%B | ( ! grep -q '\[netlify\-build\]' )"
   # Ignore if [netlify-ignore] is present
   ignore = "git log -1 --pretty=%B | ( grep -q '\\[netlify\\-ignore\\]' )"
 
+[context.deploy-preview]
+  command = "yarn develop"
+
 [[redirects]]
   from = "/docs/*"
   to = "/:splat"
@@ -14,7 +18,3 @@
   to = "/assets/docs.bundle.js"
   status = 200
 
-[[plugins]]
-package = "@algolia/netlify-plugin-crawler"
-  [plugins.inputs]
-  branches = ['DOC-65_Algolia-crawl']