middleman-lunr 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a214534d3b05285f6c9aafbeee228de77bf07e4b
-  data.tar.gz: b733b32a89f7fe3dafc4648fecfd07bdb8686134
+  metadata.gz: fab594a7ce40c116fd6e0e7c444ea5937cb194c4
+  data.tar.gz: 2aad28f0bae7924142f1703eee600a13ef65af2f
 SHA512:
-  metadata.gz: af42f4608d07386b0322a791c1d39f8dc2efe8205c53e9369ac8293744c4a1fd8e5cb03498ebffc1f068dc5fa364eeee38ca0986a6a21c9febad416f41f4d4db
-  data.tar.gz: aa486320d365eb478d1f21a6aa459f885d0928c6e88b5882508657e4271793ae5d44b9cd9b7e11b66859328a6d311322a1ff0ab9f8f376a9e634126b3080e92b
+  metadata.gz: 29da568910eb8d7271206840f83d3954565b3ab9dfd5d46da45c0ee6d9b24ba60ce97ff1f697890cb5abba6585b5134a0b3923e28f8cc9c1d4bcf82fb18d1a0c
+  data.tar.gz: a3ac800d4e0d821c8a262ab1364896cf0a6b932575afe8531b8bebf8dd79ec4a009e7b67b31f9abe75376a391742e5f90318637297c6d0650c535c10d6e91a0a

data/README.md

@@ -1,9 +1,11 @@
 # middleman-lunr
 
-**middleman extension for static indexed search using lunr.js**
+**middleman extension for a static indexed search using lunr.js**
 
 Create a queryable index of your static site content to use with lunr.js.
 
+A demo can be found at: <https://docs.shiftr.io>.
+
 ## Usage
 
 Add gem to your Gemfile:
@@ -12,26 +14,49 @@ Add gem to your Gemfile:
 gem 'middleman-lunr'
 ```
 
-Activate the extension:
+Activate the extension in `config.rb`:
 
 ```ruby
 activate :lunr
 ```
 
-Create a JSON template `search.json.erb` and generate the index:
+Mark the files you wanna index in the [frontmatter](https://middlemanapp.com/basics/frontmatter/):
+
+```
+index: true
+```
+
+Create a JSON template `source/search.json.erb` and generate the index and map:
 
 ```html
-<%= JSON.generate(generate_search_index) %>
+<%= JSON.generate(generate_search_index({data: [:title, :description]}), max_nesting: false) %>
+```
+- The generated json will include the lunr.js index under the `index` key and a map that translates lunr.js references to your middleman pages under the `map` key.
+- The `data` argument is an array of [frontmatter](https://middlemanapp.com/basics/frontmatter/) variables that you'd like to include in the map.
+
+Reference the lunr.js library in your `layouts/layout.html.erb`:
+
+```html
+<script src="//cdnjs.cloudflare.com/ajax/libs/lunr.js/0.5.9/lunr.min.js" type="text/javascript"></script>
 ```
 
 Load and query the index:
 
 ```js
+var index;
+var map;
+
 function loadIndex(){
   $.getJSON('/search.json', function(data){
-    var index = lunr.Index.load(data.index);
-    var map = data.map
-    console.log(index.search('Lunr.js'));
+    index = lunr.Index.load(data.index);
+    map = data.map
+  });
+}
+
+function queryIndex(term) {
+  index.search(term).forEach(function(res){
+    // use the map to get the page title
+    console.log(map[res.ref].title);
   });
 }
 ```

data/lib/middleman-lunr/indexer.rb

@@ -58,7 +58,7 @@ module Middleman::Lunr
         idx.add(doc)
       end
 
-      data = JSON.parse(idx.dumpIndex())
+      data = JSON.parse(idx.dumpIndex(), max_nesting: false)
 
       { index: data, map: map }
     end

data/middleman-lunr.js.gemspec

@@ -3,12 +3,12 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'middleman-lunr'
-  s.version     = '0.2.0'
+  s.version     = '0.2.1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Joël Gähwiler']
   s.email       = ['joel.gaehwiler@gmail.com']
   s.homepage    = 'https://github.com/256dpi/middleman-lunr'
-  s.summary     = 'middleman extension for static indexed search using lunr.js'
+  s.summary     = 'middleman extension for a static indexed search using lunr.js'
   s.description = 'Create a queryable index of your static site content to use with lunr.js.'
   s.license     = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-lunr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joël Gähwiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -73,9 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: middleman extension for static indexed search using lunr.js
+summary: middleman extension for a static indexed search using lunr.js
 test_files: []
-has_rdoc: