Initial conversion

Author: rickkas7

npm-shrinkwrap.json

@@ -30,7 +30,6 @@
         "gulp-replace": "^0.6.1",
         "handlebars": "^3.0.1",
         "lodash": "^4.17.4",
-        "lunr": "^0.7.2",
         "marked": "^0.3.6",
         "md5": "^2.2.1",
         "metalsmith": "^2.3.0",
@@ -45,7 +44,6 @@
         "metalsmith-in-place": "^1.0.1",
         "metalsmith-layouts": "^1.8.0",
         "metalsmith-less": "^2.0.0",
-        "metalsmith-lunr": "git://github.com/particle-iot/metalsmith-lunr#0.3.1",
         "metalsmith-markdown": "spark/metalsmith-markdown#v0.4.2",
         "metalsmith-move-up": "^1.0.0",
         "metalsmith-paths": "2.1.1",

package.json

@@ -32,8 +32,6 @@ var fixLinks = require('./fixLinks');
 var inPlace = require('metalsmith-in-place');
 var watch = require('metalsmith-watch');
 var autotoc = require('metalsmith-autotoc');
-var lunr = require('metalsmith-lunr');
-var lunr_ = require('lunr');
 var fileMetadata = require('metalsmith-filemetadata');
 var msIf = require('metalsmith-if');
 var precompile = require('./precompile');
@@ -62,9 +60,6 @@ var generateSearch = process.env.SEARCH_INDEX !== '0';
 
 var noScripts = false;
 
-// Make Particle.function searchable with function only
-lunr_.tokenizer.separator = /[\s\-.]+/;
-
 exports.metalsmith = function () {
   function removeEmptyTokens(token) {
     if (token.length > 0) {
@@ -124,7 +119,7 @@ exports.metalsmith = function () {
     }))
     // Add properties to files that match the pattern
     .use(fileMetadata([
-      { pattern: 'content/**/*.md', metadata: { lunr: generateSearch, assets: '/assets', branch: gitBranch, noScripts: noScripts } }
+      { pattern: 'content/**/*.md', metadata: { assets: '/assets', branch: gitBranch, noScripts: noScripts } }
     ]))
     .use(msIf(
       environment === 'development',
@@ -295,18 +290,6 @@ exports.metalsmith = function () {
       selector: 'h2, h3',
       pattern: '**/**/*.md'
     }))
-    // Generate Lunr search index for all the files that have lunr: true
-    // This is slow. Use SEARCH_INDEX=0 in development to avoid creating this file
-    .use(lunr({
-      indexPath: 'search-index.json',
-      fields: {
-        contents: 1,
-        title: 10
-      },
-      pipelineFunctions: [
-        removeEmptyTokens
-      ]
-    }))
     // For files that have a template frontmatter key, look for that template file in the configured directory and
     // render that template using the Metalsmith file with all its keys as context
     .use(layouts({

scripts/metalsmith.js

@@ -1,5 +1,5 @@
 /* eslint-env browser */
-/* global jQuery, lunr, Handlebars, prettyPrint */
+/* global jQuery, Handlebars, prettyPrint */
 /*!
 
 Documentation middleware.
@@ -228,45 +228,6 @@ Created by Zach Supalla.
   Docs.resultsAdded = 0;
 
   Docs.buildSearch = function() {
-    if (typeof lunr === 'undefined') {
-      return;
-    }
-    // Make Particle.function searchable with function only
-    lunr.tokenizer.separator = /[\s\-.]+/;
-    lunr.Pipeline.registerFunction(Docs._removeEmptyTokens, 'removeEmptyTokens');
-
-    $.getJSON('/search-index.json', function(data) {
-      var store = data.store;
-      var idx = lunr.Index.load(data.index);
-      $('input.search-box').keyup(function() {
-        var searchQuery = this.value;
-        var specifier="";
-        if (searchQuery.indexOf(":")!=-1) { // if the searchQuery has a specifier
-          specifier = searchQuery.split(":")[0];
-          searchQuery = searchQuery.split(":")[1];
-        }
-        Docs.emptyResults();
-        if (searchQuery === '' || searchQuery.length < 3) {
-          $('.search-results').hide();
-        } else {
-          $('.search-results').show();
-          var results = idx.search(searchQuery);
-
-          // filter by section
-          var sectionResults = Docs.filterSearchBySection(results,specifier);
-
-          // define urls to prioritize
-          // var urlArray = ["faq/particle-devices/led-troubleshooting/photon/#blinking-green"];
-          // Docs.boostSearchByUrl(sectionResults,urlArray);
-
-          // filter by device
-          var topFilteredResults = Docs.filterSearchByDevice(sectionResults,specifier);
-
-          // build search
-          Docs.buildSearchResults(topFilteredResults, store);
-        }
-      });
-    });
 
     $('body').click(function() {
       $('.search-results').hide();
@@ -288,121 +249,6 @@ Created by Zach Supalla.
     return stringToTitleCase;
   };
 
-  Docs.boostSearchByUrl = function(results,urlArray) {
-    var resultsBoost=[];
-    // if the results you get contain a particular URL, push this URL to the top of the pile.
-    for (x=0; x<results.length; x++) {
-      // check to see if there is any overlap between the two arrays
-      var currentResult = results[x];
-      var currentUrl = String(currentResult.ref);
-      for (y=0; y<urlArray.length; y++) {
-        if (currentUrl.indexOf(urlArray[y])!=-1) {
-          // splice
-          results.splice(x-1,x);
-          // unshift
-          results.unshift(currentResult);
-        }
-      }
-    }
-    return resultsBoost;
-  }
-
-  Docs.filterSearchBySection = function(results,specifier) {
-    var pathSearch = window.location.pathname.split("/").filter(function(n){return n!=""});
-    var sectionSearch = pathSearch[0];
-
-    var sectionFilteredResults = [];
-    var allSections = ["guide","tutorials","faq","reference","support"];
-
-    if (specifier.length>0) { // if the searchQuery has a specifier
-      if (allSections.indexOf(specifier)!=-1) {  // if your specifier identifies one of the sections
-        // narrow by that section
-        for (x=0; x<results.length; x++) {
-          var params = String(results[x].ref);
-          if (params.indexOf(specifier)!=-1) {  // if the specifier is in this ref, then include it
-            sectionFilteredResults.push(results[x]);
-          }
-        }
-      }
-      else { // if specifier is "all" or anything else, no need to narrow by section
-        sectionFilteredResults = results;
-      }
-    }
-    // else {  // if there is no specifier, then narrow by current section
-    //   for (x=0; x<results.length; x++) {
-    //     var params = String(results[x].ref);
-    //     if (params.indexOf(sectionSearch)!=-1) {  // if the this section is in this ref, then include it
-    //       sectionFilteredResults.push(results[x]);
-    //     }
-    //   }
-    // }
-
-    else { // if there is no specifier, then search all
-      sectionFilteredResults = results;
-    }
-
-    return sectionFilteredResults;
-  }
-
-  Docs.filterSearchByDevice = function(results,specifier) {
-    var pathSearch = window.location.pathname.split("/").filter(function(n){return n!=""});
-    var deviceSearch = pathSearch[pathSearch.length - 1];
-
-    var allDevices = ["photon","core","electron","argon","boron","xenon"];
-
-    if (specifier.length>0) {
-      if (allDevices.indexOf(specifier)!=-1) { // the specifier is one of the devices
-        deviceSearch=specifier;
-      }
-    }
-
-    var topFilteredResults = [];
-
-    if (allDevices.indexOf(deviceSearch)!=-1) { // this section has device sensitivity
-      for (x=0; x<results.length; x++) {
-        var params = String(results[x].ref);
-        var paramDeviceCount=0;
-        for (y=0; y<allDevices.length; y++) {
-          if (params.indexOf(allDevices[y])>=0) {
-            paramDeviceCount++;
-          }
-        }
-        if (paramDeviceCount==0) {  // does it have one of the allDevices in it?
-          topFilteredResults.push(results[x]);
-        }
-        else {  // check to see if it includes the deviceSearch term
-          if (String(results[x].ref).indexOf(deviceSearch) >= 0) {
-            topFilteredResults.push(results[x]);
-          }
-        }
-      }
-    }
-    else {  // this section does not have device sensitivity, do not filter by device
-      // probably should filter by some "default" device, whatever is what people most likely want to see
-      topFilteredResults=results;
-    }
-    return topFilteredResults;
-  }
-
-  Docs.buildSearchResults = function(results, store) {
-    var fiveResults = results.slice(0,5);
-
-    var niceResults = fiveResults.map(function(r) {
-      var resultInfo = store[r.ref];
-      var nr = {};
-      nr.link = r.ref;
-      nr.title = resultInfo.title;
-      nr.device = resultInfo.device;
-      nr.collection = Docs.titleize(resultInfo.collection);
-      nr.pageTitle = resultInfo.pageTitle;
-      nr.collectionClass = resultInfo.collection;
-      return nr;
-    });
-
-    var html = Handlebars.templates.search({results: niceResults});
-    $('.search-results').append(html);
-  };
-
   Docs.toggleShowing = function() {
     $('span.popupLink, span.footnoteLink').on('click', function() {
       $(this).toggleClass('showing');

src/assets/js/docs.js.hbs

@@ -13,7 +13,7 @@ layout: page-not-found.hbs
       <div class="search">
         <div class="search-input-wrapper">
           <i class="ion-search"></i>
-          <input class="search-box" type="text" placeholder="Search" value=""/>
+          <input class="st-default-search-input" type="text" placeholder="Search" value=""/>
         </div>
         <div class="search-results">
         </div>

src/content/page-not-found.md

@@ -10,7 +10,7 @@
     <div class='content-root'>
       <div class='menubar'>
 
-      <ul class="nav guide-menu">
+      <ul class="nav guide-menu" data-swiftype-index="false">
         {{#each reference}}
         <li data-level="{{inc @index}}" class="guide-section {{#contains ../path.href section}}active-section{{/contains}}">
           <h3 class="guide-section-titles" >{{{titleize section}}}</h3>

templates/layouts/api.hbs

@@ -9,7 +9,7 @@
 
     <div class='content-root'>
       <div class='menubar'>
-      <ul class="nav guide-menu">
+      <ul class="nav guide-menu" data-swiftype-index="false">
         {{#each community}}
            <ul>
               <li class="top-level {{#page-equal ../path.href ../path.name path.href path.name}}active{{/page-equal}}">

templates/layouts/community.hbs

@@ -9,7 +9,7 @@
 
     <div class='content-root'>
       <div class='menubar'>
-      <ul class="nav guide-menu">
+      <ul class="nav guide-menu" data-swiftype-index="false">
         {{#each datasheets}}
         <li data-level="{{inc @index}}" class="guide-section {{#contains ../path.href section}}active-section{{/contains}}">
           <h3 class="guide-section-titles" >{{{titleize section}}}</h3>

templates/layouts/datasheet.hbs

@@ -9,7 +9,7 @@
 
     <div class='content-root'>
       <div class='menubar'>
-      <ul class="nav guide-menu">
+      <ul class="nav guide-menu" data-swiftype-index="false">
         {{#each faq}}
         <li data-level="{{inc @index}}" class="guide-section {{#contains ../path.href section}}active-section{{/contains}}">
           <h3 class="guide-section-titles" >{{{titleize section}}}</h3>