royalfig/algolia-helpcenter-search

Ghost Algolia tools

Ghost Algolia tools offers tools to index and fragment Ghost posts to an Algolia index. It consists of two user facing tools:

• algolia, which is a CLI tool to batch index the full content of a Ghost install to a defined Algolia index
• algolia-netlify, which uses Netlify Functions to listen to Ghost webhooks and add, update, and remove posts to an Algolia index

Usage

Algolia Netlify package

You can start using the Algolia Netlify package by clicking on this deplooy button. You can find the detailed install and user instructions over here.

Ghost Algolia CLI

While the Algolia Netlify tool is useful to maintain your search index, the Ghost Algolia CLI is good for the initial indexing of the full post content of a site. See full install and user instructions in the package description here.

Develop

This is a mono repository, managed with lerna.

1. git clone this repo & cd into it as usual
2. yarn setup is mapped to lerna bootstrap
   • installs all external dependencies
   • links all internal dependencies

To add a new package to the repo:

• install slimer
• run slimer new <package name>

Run

• yarn dev

Test

• yarn lint run just eslint
• yarn test run lint and tests

Publish

• yarn ship is an alias for lerna publish
  • Publishes all packages which have changed
  • Also updates any packages which depend on changed packages

Copyright & License

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.

algolia-helpcenter-search's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency dotenv-webpack to v8.1.0
• Update dependency eslint to v9
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency webpack to v5.76.0 [SECURITY]
• Update dependency @tryghost/content-api to v1.11.21
• Update dependency @tryghost/pretty-cli to v1.2.41
• Update dependency netlify-lambda to v2.0.16
• Update dependency sinon to v14.0.2
• Update dependency @tryghost/errors to v1.3.2
• Update dependency algoliasearch to v4.23.3
• Update dependency eslint to v8.57.0
• Update dependency eslint-plugin-ghost to v2.18.1
• Update dependency eslint-plugin-import to v2.29.1
• Update dependency fs-extra to v11.2.0
• Update dependency mocha to v10.4.0
• Update dependency sinon to v15.2.0
• Update actions/checkout action to v4
• Update actions/setup-node action to v4
• Update dependency eslint-plugin-ghost to v3
• Update dependency node to v20
• Update dependency sinon to v17
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/test.yml

• actions/checkout v3
• actions/setup-node v2

npm

package.json

• eslint 8.31.0
• eslint-plugin-ghost 2.16.0
• mocha 10.2.0
• should 13.2.3
• sinon 15.0.1

packages/algolia-fragmenter/package.json

• algolia-html-extractor 0.0.1
• mocha 10.0.0
• should 13.2.3
• sinon 14.0.0

packages/algolia-indexer/package.json

• @tryghost/errors 1.2.20
• algoliasearch 4.14.3
• mocha 10.0.0
• should 13.2.3
• sinon 14.0.0

packages/algolia-netlify/package.json

• dotenv-webpack 8.0.1
• netlify-lambda 2.0.15
• webpack 5.75.0
• eslint 8.22.0
• eslint-config-airbnb-base 15.0.0
• eslint-plugin-ghost 2.15.1
• eslint-plugin-import 2.26.0
• mocha 10.0.0
• should 13.2.3
• sinon 14.0.0

packages/algolia/package.json

• @tryghost/content-api 1.11.5
• @tryghost/errors 1.2.20
• @tryghost/pretty-cli 1.2.33
• fs-extra 11.1.0
• mocha 10.0.0
• should 13.2.3
• sinon 14.0.0

nvm

.nvmrc

• node 16

packages/algolia-netlify/.nvmrc

• node 16

---

• Check this box to trigger a request for Renovate to run again on this repository