Schema and guidelines for creating a staticSearch engine for your HTML5 site
Martin Holmes
Joey Takeda
2019–2026

This documentation provides instructions on how to use the Project Endings staticSearch Generator to provide a fully-functional search ‘engine’ to your website without any dependency on server-side code such as a database.

2 What do I need in order to use this?

In order to build a static search index on your document collection, you will need:

Once you have run the indexing process on your document collection, you can place the results on any web server and the search will work with any modern browser. The requirements above are only for building the search index, which you only need to do once (until your documents change).

It is important to note that most browsers prevent some JavaScript interactions when a local file is loaded from disk; in other words, you will not be able to test your staticSearch implementation just by loading the search page into your browser. You will need to host your site on a web server in order to test the search page. You can either do this by uploading your site to a web server on which you have an account, or you can run a local developer-friendly web server on your computer; Python, PHP, and Node/NPM all have built-in servers you can use.

Martin Holmes and Joey Takeda. Date: 2019–2026