Ghost Finder - The most advanced ghost search plugin

#1

Hello guys, I made this search plugin for the ghost theme developer community

Ghost Finder

Installation

Include script

<script src="{{asset "ghost-search/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

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

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 15 word count to show in ##excerpt variable
time_format 'MMMM Do YYYY' Time format string for ##published_at variable

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

Variable 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
2 Likes
#2

Sounds good. But is there any demo or pictures/gifs of the work?

1 Like
#3

We used this in our theme -> http://delas.electronthemes-ghost.com/
In this theme for search result we only used ##title and ##excerpt variable.
You can use also these variables

Variable 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