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 🙏

© 2024 – Pkg Stats / Ryan Hefner

ghost-finder

v3.1.2

Published

The most advance ghost search plugin

Downloads

121

Readme

Ghost Finder

Installation

npm install ghost-finder

OR

download Download Latest Release

Include script

<script src="{{asset "ghost-finder/dist/ghost-finder.js"}}"></script>

Setup markup

<div>
  <input id="search-input" type="text" placeholder="Type to search" />
  <div id="search-result"></div>
</div>

Activate the plugin

new GhostFinder({
    input: '#search-input',
    showResult: '#search-result',
    contentApiKey: //CONTENT API KEY...,
})

To see how you can get contentApiKey , Click Here


Options

| Name | Default Value | Details | | -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- | | input | null Required | DOM selector of search input | | showResult | null Required | DOM selector where search result will be pluged-in | | homeUrl | current website url | Your ghost site url | | contentApiKey | null Required | content api key | | resultTemplate | see bellow | Result wrapper template for search result | | singleResultTemplate | see bellow | Single search result template | | excerpt_length | 250 | word count to show in ##excerpt variable | | time_format | 'MMMM dd yyyy' | Time format string for ##published_at variable. Available formats |

Default templates

Result Template

<ul class="search-results-wrapper">
  <p>Search match(es): ##resultCount</p>
  ##results
</ul>

Single Result Template

<li><a href="##url">##title</a></li>

Variables

| Field Name | Purpose | | ------------------------- | ------------------------------------------------------------------- | | ##title | Post title | | ##url | Post url | | ##primary_tag_name | Name of primary tag | | ##primary_tag_url | Url of primary tag | | ##primary_author_name | Name of primary author | | ##primary_author_url | Profile url of primary author | | ##primary_author_avater | Profile photo of primary author | | ##excerpt | show some words of the post content. Default words count is 15 | | ##published_at | Post publication date. Format can be change by time_format option | | ##feature_image | Post featured image url | | ##resultCount | Matched result count |

Logs