Since search-index.js is loaded asynchronously, it needs to be the place that initializes the index, so add new global initializeSearch function that it can call; load scripts from https; improve feedback in doc:site; style cleanup

Author: GeoffreyBooth

Cakefile

@@ -179,14 +179,11 @@ buildDocs = (watch = no) ->
   sectionsSourceFolder = 'documentation/sections'
   examplesSourceFolder = 'documentation/examples'
   outputFolder         = "docs/v#{majorVersion}"
-  searchCollections    = docs: [], changelogs: []
   {structure}          = require "./documentation/structure.coffee"
 
-  monthNames = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
-
-  formatDate = (date) ->
-    date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
-      "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
+  searchCollections =
+    docs: []
+    changelogs: []
 
   # Helpers
   releaseHeader = (date, version, prevVersion) ->
@@ -198,6 +195,11 @@ buildDocs = (watch = no) ->
       </h2>
     """
 
+  monthNames = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
+  formatDate = (date) ->
+    date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
+      "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
+
   codeFor = require "./documentation/site/code.coffee"
 
   # Template for search results.
@@ -241,7 +243,7 @@ buildDocs = (watch = no) ->
       .replace /^\s+/g, " "
 
   # Build search catalog.
-  searchCatalogue = (mdDoc, section, data) ->
+  searchCatalog = (mdDoc, section, data) ->
     return unless match = /^(#+?)\s+([^\n]+)\s+([\s\S]+)/.exec mdDoc
     [, level, title, body] = match
     content = clean body
@@ -293,7 +295,7 @@ buildDocs = (watch = no) ->
       md = md.replace /<%= releaseHeader %>/g, releaseHeader
       md = md.replace /<%= majorVersion %>/g, majorVersion
       md = md.replace /<%= fullVersion %>/g, CoffeeScript.VERSION
-      searchCatalogue md, file, searchData
+      searchCatalog md, file, searchData
       html = markdownRenderer.render md
       html = _.template(html)
         codeFor: codeFor()
@@ -391,11 +393,14 @@ buildDocs = (watch = no) ->
       window.searchResultTemplate = #{searchResultsTemplate};
       window.searchResultsListTemplate = #{searchResultsListTemplate};
       window.searchCollections = #{JSON.stringify searchCollections};
+      window.initializeSearch();
     """
     fs.writeFileSync "#{outputFolder}/search-index.js", searchIdx
+    log 'output', green, "#{outputFolder}/search-index.js"
     fs.writeFileSync "#{outputFolder}/index.html", output
     log 'compiled', green, "#{indexFile} → #{outputFolder}/index.html"
   try
+    fs.symlinkSync "v#{majorVersion}/search-index.js", 'docs/search-index.js'
     fs.symlinkSync "v#{majorVersion}/index.html", 'docs/index.html'
   catch exception
 

docs/v2/index.html

@@ -13,7 +13,7 @@
           <%= include('logo.svg') %>
         </p>
       </header>
-      <%= buildBody()  %>
+      <%= buildBody() %>
     </main>
   </div>
 </div>

docs/v2/search-index.js

@@ -209,28 +209,29 @@ $(document).ready ->
         # Initializing the code editors might’ve thrown off our vertical scroll position
         document.getElementById(window.location.hash.slice(1).replace(/try:.*/, '')).scrollIntoView()
 
-  buildSearch = (catalogue, keys) ->
-    searchOptions = {
-      includeScore: true,
-      shouldSort: true,
-      includeMatches: true,
-      threshold: 0.2,
-      location: 0,
-      distance: 1000,
-      maxPatternLength: 32,
-      minMatchCharLength: 4,
-      keys
-    }
-    new Fuse window.searchCollections[catalogue], searchOptions
-
-  window.fuseDocs = buildSearch "docs", ["section", "content"]
-  window.fuseLogs = buildSearch "changelogs", ["content"]
-
-
-$(document).on "keyup", "#cs-search-input-navbar", ->
-  resContainer = $("#search-results")
-  searchResultBox = $("#searchResultBox")
-  resContainer.hide().html ""
+
+# This function is called from search-index.js, which is loaded asynchronously
+window.initializeSearch = ->
+  buildSearch = (catalog, keys) ->
+    searchOptions =
+      keys: keys
+      includeScore: yes
+      shouldSort: yes
+      includeMatches: yes
+      threshold: 0.2
+      location: 0
+      distance: 1000
+      maxPatternLength: 32
+      minMatchCharLength: 4
+    new Fuse window.searchCollections[catalog], searchOptions
+
+  window.fuseDocs = buildSearch 'docs', ['section', 'content']
+  window.fuseLogs = buildSearch 'changelogs', ['content']
+
+$(document).on 'keyup', '#cs-search-input-navbar', ->
+  resContainer = $('#search-results')
+  searchResultBox = $('#searchResultBox')
+  resContainer.hide().html ''
   searchResultBox.hide()
   return unless @value.length >= 3
   markText = (text) ->
@@ -246,8 +247,8 @@ $(document).on "keyup", "#cs-search-input-navbar", ->
       marked = markText content[m[0]...m[1]]
       start = if m[0] > 50 then m[0] - 50 else 0
       end = m[1] + 50
-      mContent.push "…" + content[start...m[0]] + marked + content[m[1]...end] + "…"
-    mContent.join " "
+      mContent.push '…' + content[start...m[0]] + marked + content[m[1]...end] + '…'
+    mContent.join ' '
 
   tmpl = window.searchResultTemplate
   tmplList = window.searchResultsListTemplate
@@ -260,10 +261,10 @@ $(document).on "keyup", "#cs-search-input-navbar", ->
       countMatches = 0
       for match in matches
         {key, indices} = match
-        if key is "section" and indices.length > 0
+        if key is 'section' and indices.length > 0
           title = markTitle title, indices
           countMatches += indices.length
-        if key is "content"
+        if key is 'content'
           content = markContent content, indices
           countMatches += indices.length
       continue if countMatches < 1
@@ -280,16 +281,16 @@ $(document).on "keyup", "#cs-search-input-navbar", ->
     continue if list.length < 1
     ctmpl = tmpl
       section: key
-      results: list.join ""
+      results: list.join ''
     results.push ctmpl
 
   if results.length > 0
     searchResultBox.show()
-    resContainer.show().html results.join ""
+    resContainer.show().html results.join ''
 
-$(document).on "click", ".searchWrapper", ->
-  href = $(this).data "href"
-  if href[0] is "#"
+$(document).on 'click', '.searchWrapper', ->
+  href = $(this).data 'href'
+  if href[0] is '#'
     window.location.hash = href
   else
-    window.location = href
+    window.location = href

documentation/site/body.html

@@ -1,5 +1,5 @@
 <nav class="navbar navbar-expand-lg fixed-top navbar-dark bg-dark bg-ribbed-dark site-navbar">
-  <a class="navbar-brand" href="#" data-close="try"><%= include('logo.svg') %></a>
+  <a class="navbar-brand" href="#" data-close="try" data-action="scroll-to-top"><%= include('logo.svg') %></a>
   <button class="navbar-toggler" type="button" data-toggle="offcanvas" data-close="try" aria-label="Toggle sidebar">
     <span class="navbar-toggler-icon"></span>
   </button>

documentation/site/docs.coffee

@@ -1,9 +1,9 @@
-<script src="//ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha384-xBuQ/xzmlsLoJpyjoggmTEz8OWUFM0/RC5BsqQBDX2v5cMvDHcMakNTNrHIW2I5f" crossorigin="anonymous"></script>
-<script src="//stackpath.bootstrapcdn.com/bootstrap/4.1.0/js/bootstrap.min.js" integrity="sha384-uefMccjFJAIv6A+rW+L4AHf99KvxDjWSu1z9VI8SKNVmz4sk7buKt/6v9KI65qnm" crossorigin="anonymous"></script>
-<script src="//cdn.jsdelivr.net/combine/npm/[email protected]/lib/codemirror.js,npm/[email protected]/mode/coffeescript/coffeescript.js,npm/[email protected]/addon/lint/coffeescript-lint.js,npm/[email protected]/mode/javascript/javascript.js,npm/[email protected]/dist/fuse.min.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha384-xBuQ/xzmlsLoJpyjoggmTEz8OWUFM0/RC5BsqQBDX2v5cMvDHcMakNTNrHIW2I5f" crossorigin="anonymous"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/js/bootstrap.min.js" integrity="sha384-uefMccjFJAIv6A+rW+L4AHf99KvxDjWSu1z9VI8SKNVmz4sk7buKt/6v9KI65qnm" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/combine/npm/[email protected]/lib/codemirror.js,npm/[email protected]/mode/coffeescript/coffeescript.js,npm/[email protected]/addon/lint/coffeescript-lint.js,npm/[email protected]/mode/javascript/javascript.js,npm/[email protected]/dist/fuse.min.js"></script>
 <script src="browser-compiler/coffeescript.js"></script>
 <script>
 <%= includeScript('docs.coffee') %>
 </script>
 <script async src="search-index.js"></script>
-<script async src="//www.googletagmanager.com/gtag/js?id=UA-106156830-1"></script>
+<script async src="https://www.googletagmanager.com/gtag/js?id=UA-106156830-1"></script>