Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kingRayhan/ghost-finder
The most advanced ghost search plugin
https://github.com/kingRayhan/ghost-finder
ghost ghost-theme search
Last synced: 5 days ago
JSON representation
The most advanced ghost search plugin
- Host: GitHub
- URL: https://github.com/kingRayhan/ghost-finder
- Owner: kingRayhan
- License: mit
- Created: 2019-03-26T13:19:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-10T14:51:19.000Z (about 2 years ago)
- Last Synced: 2024-10-29T22:58:43.278Z (10 days ago)
- Topics: ghost, ghost-theme, search
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ghost-finder
- Size: 821 KB
- Stars: 52
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - kingRayhan/ghost-finder - The most advanced ghost search plugin (others)
README
# Ghost Finder
Here's a helpful npm package I made. This addon allows you to easily and sweetly incorporate search features into your ghost theme. It operates using the Ghost Content API.
## Installation
```bash
npm install ghost-finder
```
### OR
 [Download Latest Release](https://github.com/kingRayhan/ghost-finder/releases/latest)
**Include script**
```html
```
**Setup markup**
```html
```
**Activate the plugin**
```js
new GhostFinder({
input: '#search-input',
showResult: '#search-result',
contentApiKey: //CONTENT API KEY...,
})
```
To see how you can get contentApiKey , [Click Here](https://github.com/kingrayhan/ghost-finder/wiki/How-to-get-contentApiKey-%3F)
---
### 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](https://date-fns.org/v2.22.1/docs/format#description) |
### Default templates
**Result Template**
```html
Search match(es): ##resultCount
##results
```
**Single Result Template**
```html
```
### 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
- 3.1.0 - Search on content along with title, Replace [laravel-mix](https://laravel-mix.com/) with [parcel](https://parceljs.org/)