jekyll-search-js
🔍 Search through your jekyll pages, posts, or any collection the ES6 way. See a demo
Installation
- Download the source files (
src/
) or install with npm - Drop these files into your
assets/
directory (or preferred directory) - Link the
search.js
file andfetch.js
polyfill:
<script type="text/javascript" src="./src/fetch.js"></script>
<script type="text/javascript" src="./src/search.js"></script>
- Initialise a new search:
<script type="text/javascript">
// New search using example options
const search = new jekyllSearch(
'https://alembic.darn.es/assets/search.json',
'#search',
'#list',
'https://alembic.darn.es'
);
// Initialise
search.init();
</script>
Options
const search = new jekyllSearch(
'https://alembic.darn.es/assets/search.json', // Your data source, can be relative or absolute
'#search', // The selector of your search input field
'#list', // The selector of your search results wrapper
'https://alembic.darn.es' // Optional site url for absolute urls
);
To do
- Get js into a class
- Allow options to be set
- Finish installation readme
- Add how to be installed using npm
- Submit to npmjs.com