Back to Ghost

Comments UI

apps/comments-ui/README.md

6.36.01.7 KB
Original Source

Comments UI

Comments widget that is embedded at the bottom of posts in Ghost.

Development

Pre-requisites

  • Run pnpm in Ghost monorepo root

Running via Ghost pnpm dev in root folder

Comments UI runs automatically when using Ghost's development command from the monorepo root:

bash
pnpm dev

Release

A patch release can be rolled out instantly in production, whereas a minor/major release requires the Ghost monorepo to be updated and released. In either case, you need sufficient permissions to release @tryghost packages on NPM.

Patch release

  1. Run pnpm ship and select a patch version when prompted
  2. Merge the release commit to main

Minor / major release

  1. Run pnpm ship and select a minor or major version when prompted
  2. Merge the release commit to main
  3. Wait until a new version of Ghost is released

JsDelivr cache

If the CI doesn't clear JsDelivr cache to get the new version out instantly, you may want to do it yourself manually (docs). Typically, you'll need to open https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/comments-ui.min.js and https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/main.css in your browser, where COMMENTS_UI_VERSION is the latest minor version in ghost/core/core/shared/config/defaults.json (code)

Copyright & License

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