Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 0 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down Expand Up @@ -299,6 +314,7 @@ layout: none

- `npm install`
- `npm test`
- `npm run dist`

#### Acceptance tests

Expand Down
4 changes: 2 additions & 2 deletions dest/simple-jekyll-search.js
Original file line number Diff line number Diff line change
@@ -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.
*/

Expand Down
4 changes: 2 additions & 2 deletions dest/simple-jekyll-search.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions example/js/simple-jekyll-search.js
Original file line number Diff line number Diff line change
@@ -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.
*/

Expand Down
4 changes: 2 additions & 2 deletions example/js/simple-jekyll-search.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down Expand Up @@ -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"
},
Expand Down
2 changes: 1 addition & 1 deletion scripts/stamp.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/

Expand Down