Merge pull request #7 from neilboyd/single-word

minor updates

Author: neilboyd

.devcontainer/devcontainer.json

@@ -7,7 +7,8 @@
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	"features": {
-		"ghcr.io/devcontainers-contrib/features/node-asdf:0": {}
+		"ghcr.io/devcontainers-contrib/features/node-asdf:0": {},
+		"ghcr.io/schlich/devcontainer-features/cypress:1": {}
 	}
 
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.

.github/workflows/main.yml

@@ -22,10 +22,6 @@ jobs:
       #     record: false
       #     # cache-key: node-v${{ matrix.node }}-on-${{ runner.os }}-hash-${{ hashFiles('package-lock.json') }}
 
-      # TODO delete this step in the next release
-      - name: Branch Name
-        run: echo ${GITHUB_REF}
-
       - name: publish
         if: contains(github.ref, 'refs/tags/')
         env:

README.md

@@ -2,6 +2,21 @@
 
 A JavaScript library to add search functionality to any Jekyll blog.
 
+## Fork
+
+This is a fork of
+[the original](https://github.com/christian-fei/Simple-Jekyll-Search)
+because all the
+[releases](https://github.com/christian-fei/Simple-Jekyll-Search/tags)
+after `1.9.0` were actually the same as `1.9.0` because the build step was not executed.
+
+I then made the following changes:
+- add [dev container](https://code.visualstudio.com/docs/devcontainers/containers) configuration
+- exact search using quotes instead of trailing space
+- add query parameter to middleware
+- split search criteria on words instead of space
+- add package version to header
+
 ## Use case
 
 You have a blog, built with Jekyll, and want a **lightweight search functionality** on your blog, purely client-side?
@@ -299,6 +314,7 @@ layout: none
 
 - `npm install`
 - `npm test`
+- `npm run dist`
 
 #### Acceptance tests
 

dest/simple-jekyll-search.js

@@ -1,6 +1,6 @@
 /*!
-  * Simple-Jekyll-Search 1.12.0
-  * Copyright 2015-2024, Christian Fei
+  * Simple-Jekyll-Search 1.12.1
+  * Copyright 2015-2024, Christian Fei, Neil Boyd
   * Licensed under the MIT License.
   */
 

dest/simple-jekyll-search.min.js

@@ -1,6 +1,6 @@
 /*!
-  * Simple-Jekyll-Search 1.12.0
-  * Copyright 2015-2024, Christian Fei
+  * Simple-Jekyll-Search 1.12.1
+  * Copyright 2015-2024, Christian Fei, Neil Boyd
   * Licensed under the MIT License.
   */
 

example/js/simple-jekyll-search.js

@@ -1,6 +1,6 @@
 {
   "name": "simple-jekyll-search",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "description": "Simple Jekyll site search using javascript and json",
   "main": "dest/simple-jekyll-search.js",
   "scripts": {
@@ -38,7 +38,7 @@
     "ava": "^3.14.0",
     "browser-pack-flat": "^3.4.2",
     "browserify": "^17.0.0",
-    "cypress": "^6.2.0",
+    "cypress": "^6.9.1",
     "standard": "^16.0.3",
     "uglify-js": "^3.12.3"
   },

example/js/simple-jekyll-search.min.js

@@ -11,7 +11,7 @@ const year = new Date().getFullYear()
 const stampTop =
 `/*!
   * Simple-Jekyll-Search ${version}
-  * Copyright 2015-${year}, Christian Fei
+  * Copyright 2015-${year}, Christian Fei, Neil Boyd
   * Licensed under the MIT License.
   */