npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

staticsearch

v0.5.0

Published

Simple static site search system.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

craigbucklercraigbuckler

Keywords

staticsitesearchenginefindindexquery

Readme

StaticSearch

StaticSearch is a simple search engine you can add to any static website. It uses client-side JavaScript and JSON data files so there's no need for back-end server technologies or databases.

StaticSearch works with Publican but can be used on any static site built by any generator. It currently works best on English language sites, but most Western languages can be used.

Full documentation is available at publican.dev/staticsearch

View the CHANGELOG for updates

To use StaticSearch, build your static site to a directory, then:

  1. Index the pages to create JavaScript and JSON data files (do this every time your site changes).

  2. Add search functionality to your site following the first index.

Index your site

Assuming your static site is generated in a sub-directory named ./build/, run the StaticSearch CLI command:

npx staticsearch

It creates a new directory named ./build/search/ containing JavaScript code and word index data.

If your site is in a different directory, such as ./dist/, use:

npx staticsearch --builddir ./dist/

For help, refer to StaticSearch indexer or view CLI configuration help:

npx staticsearch --help

environment variable configuration help:

npx staticsearch --helpenv

or Node.js API configuration help:

npx staticsearch --helpapi

Add search functionality to your site

StaticSearch provides a web component to quickly add search facilities to your site. Add the following snippet to any template, perhaps in the HTML <header>:

<script type="module" src="/search/staticsearch-component.js"></script>

<static-search title="press Ctrl+K to search">
  <p>search</p>
</static-search>

Any HTML element can be placed inside <static-search> to activate search when it's clicked. You can now rebuild the site to include this update and re-run the indexer.

For full help, refer to: