Add initial implementation of search bar

Signed-off-by: lucperkins <lucperkins@gmail.com>
pcaruana · Aug 21, 2019 · 614670e · 614670e
1 parent 91d98c7
commit 614670e
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 1 deletion.
diff --git a/docs/website/config.toml b/docs/website/config.toml
@@ -16,6 +16,7 @@ ignorefiles = [ "/docs/v.*/code/.*" ]
 [params]
 description = "Policy-based control for cloud native environments"
 tagline = "Empower your administrators with flexible, fine-grained control across your entire stack."
+algolia_api_key = "26fa0633923a7cb9432cf2851b77dca6"
 
 [params.social]
 twitter = "OpenPolicyAgent"

diff --git a/docs/website/layouts/partials/css.html b/docs/website/layouts/partials/css.html
@@ -7,6 +7,7 @@
 {{ $cssProdOpts  := (dict "targetPath" $cssOutput "includePaths" $includePaths "outputStyle" "compressed") }}
 {{ $cssOpts      := cond $inServerMode $cssDevOpts $cssProdOpts }}
 {{ $css          := resources.Get $sass | toCSS $cssOpts }}
+{{ $isDoc        := eq .Section "docs" }}
 
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tocbot/4.7.0/tocbot.css">
 
@@ -24,3 +25,6 @@
 {{ end }}
 {{ end }}
 {{ end }}
+{{ if $isDoc }}
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
+{{ end }}
diff --git a/docs/website/layouts/partials/docs/navbar.html b/docs/website/layouts/partials/docs/navbar.html
@@ -50,6 +50,19 @@
     </div>
 
     <div class="navbar-end">
+      <!--
+      <div class="navbar-item">
+        <div class="field">
+          <p class="control is-expanded has-icons-right">
+            <input class="input" type="search" placeholder="Search...">
+            <span class="icon is-small is-right">
+              <icon />
+            </span>
+          </p>
+        </div>
+      </div>
+      -->
+
       <div class="navbar-item">
         <div class="buttons">
           <a class="button is-primary" href="{{ $github }}" target="_blank">
@@ -82,6 +95,15 @@
 
   <div class="navbar-menu">
     <div class="navbar-end">
+      <div class="navbar-item">
+        <p class="control has-icons-right">
+          <input class="input" type="search" id="search-bar" placeholder="Search...">
+          <span class="icon is-small is-right">
+            <icon />
+          </span>
+        </p>
+      </div>
+
       <a class="navbar-item" href="{{ $github }}" target="_blank">
         <span class="icon has-text-white-bis">
           <i class="fab fa-github"></i>

diff --git a/docs/website/layouts/partials/javascript.html b/docs/website/layouts/partials/javascript.html
@@ -1,5 +1,23 @@
+{{ $isDocsPage := eq .Section "docs" }}
+{{ $app        := resources.Get "js/app.js" | resources.ExecuteAsTemplate "js/app.js" . | fingerprint }}
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/tocbot/4.7.0/tocbot.min.js"></script>
-{{ $app := resources.Get "js/app.js" | fingerprint }}
 <script src="{{ $app.RelPermalink }}" integrity="{{ $app.Data.Integrity }}"></script>
 <script src="/js/anchor.min.js"></script>
+
+{{ if $isDocsPage }}
+{{ $version := index (split .File.Path "/") 1 }}
+{{ $apiKey  := site.Params.algolia_api_key }}
+<script>
+  console.log("You are reading the docs for version {{ $version }} of Open Policy Agent");
+
+  docsearch({
+    apiKey: '{{ $apiKey }}',
+    indexName: 'openpolicyagent',
+    inputSelector: '#search-bar',
+    algoliaOptions: { 'facetFilters': ["version:{{ $version }}"] },
+    debug: true
+  });
+</script>
+{{ end }}
diff --git a/docs/website/layouts/partials/meta.html b/docs/website/layouts/partials/meta.html
@@ -5,6 +5,9 @@
 {{ $pageType    := cond $isHome "website" "article" }}
 {{ $imageUrl    := "/img/logos/opa-horizontal-color.png" | absURL }}
 {{ $twitter     := site.Params.social.twitter }}
+{{ $latest      := index site.Data.releases 0 }}
+{{ $version     := index (split .File.Path "/") 1 }}
+{{ $isLatest    := eq $latest $version }}
 
 <!-- Basic metadata -->
 <meta charset="utf-8">
@@ -41,5 +44,13 @@
 <link rel="canonical" content="{{ .Permalink }}">
 <link rel="shortcut icon" href="/favicon.png" type="image/x-icon"/>
 
+<!-- Algolia metadata -->
+<meta name="docsearch:language" content="en" />
+{{ if $isLatest }}
+<meta name="docsearch:version" content='["{{ $version }}", "latest"]' />
+{{ else }}
+<meta name="docsearch:version" content="{{ $version }}" />
+{{ end }}
+
 <!-- Site generator -->
 {{ hugo.Generator }}