Drop-in script to make the bulk of Ghost membership features work on any theme.
Ghost automatically injects Portal script on all sites running Ghost 4 or higher.
Alternatively, Portal can be enabled on non-ghost pages directly by inserting the below script on the page.
<script defer src="https://unpkg.com/@tryghost/portal@latest/umd/portal.min.js" data-ghost="https://mymemberssite.com"></script>
The data-ghost
attribute expects the URL for your Ghost site, which is the only input Portal needs to work with your site's membership data via Ghost APIs.
By default, the script adds a default floating trigger button on the bottom right of your page which is used to trigger the popup on screen.
Its possible to add custom trigger button of your own by adding data attribute data-portal
to any HTML tag on page, and also specify a specific page to open from it by using it as data-portal=signup
.
The script also adds custom class names to this element for open and close state of popup - gh-portal-open
and gh-portal-close
, allowing devs to update its UI based on popup state.
Refer the docs to read about ways in which Portal can be customized for your site.
Run Portal within the Ghost monorepo with:
yarn dev --portal
Alternatively, use yarn dev --all
to load Portal and other supported apps/services, see dev.js for more information.
To run Portal in a standalone fashion, use yarn start
and open http://localhost:3000.
To create a production minified bundle in umd/portal.min.js
:
yarn build
To run tests in watch mode:
yarn test
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.
- Run
yarn ship
and select a patch version when prompted - (Optional) Clear JsDelivr cache to get the new version out instantly (docs). Typically, you'll need to open
https://purge.jsdelivr.net/ghost/portal@~${PORTAL_VERSION}/umd/portal.min.js
andhttps://purge.jsdelivr.net/ghost/portal@~${PORTAL_VERSION}/umd/main.css
in your browser, wherePORTAL_VERSION
is the latest minor version inghost/core/core/shared/config/defaults.json
(code)
- Run
yarn ship
and select a minor or major version when prompted - Update the Portal version in
ghost/core/core/shared/config/defaults.json
to the new minor or major version (code) - Wait until a new version of Ghost is released
Copyright (c) 2013-2024 Ghost Foundation - Released under the MIT license.