Back to Ghost

Sodo Search

apps/sodo-search/README.md

6.58.01.3 KB
Original Source

Sodo Search

Search interface injected into Ghost sites.

Development

Pre-requisites

  • Run pnpm setup in the Ghost monorepo root

Running via Ghost from the monorepo root

Start Ghost with the public-app watchers enabled:

bash
pnpm dev:public

This starts the standard development environment and the Sodo Search watcher. To work on this package by itself, run these commands from this directory:

bash
pnpm build    # one-off build
pnpm dev      # watch and rebuild the UMD JavaScript and CSS
pnpm test     # run unit tests once
pnpm lint     # lint source and tests

Release

Patch releases are automatic. When Sodo Search changes on main, CI publishes the next patch version to npm and clears the jsDelivr cache. Sites using that major/minor line receive the patch without a Ghost release.

For an intentional minor or major release:

  1. From a clean branch, run pnpm ship and select a minor or major version
  2. Merge the release commit to main
  3. Wait for a public Ghost release to ship the new default version line

pnpm ship updates both the package version and Ghost's default Sodo Search version.

Copyright & License

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