Skip to content
The most advanced ghost search plugin
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist resultCount variable Apr 3, 2019
src Update ghost-finder.js Apr 14, 2019
.babelrc init Apr 2, 2019
.gitignore init Apr 2, 2019
LICENSE Create LICENSE Apr 3, 2019
mix-manifest.json change lib name Apr 2, 2019
package.json v1.0.0 Apr 2, 2019
readme.md Read me updated Apr 21, 2019
webpack.mix.js change lib name Apr 2, 2019
yarn.lock v1.0.0 Apr 2, 2019

readme.md

Ghost Finder

image

Read the blog on this plugin from here

Installation

download Download ghost-finder-1.0.0.zip

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

<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

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
You can’t perform that action at this time.