@beyondwords/ghost-helper

BeyondWords Ghost Helper

The Ghost Helper aims to make the integration with Ghosts easier by placing the BeyondWords Player in the right place for your theme and by selecting the correct content based on the page URL.

Documentation

1. Getting started guide
2. Ghost docs

Examples

Basic

<script async defer src="https://proxy.beyondwords.io/npm/@beyondwords/ghost-helper@latest/dist/umd.js"
  onload="new BeyondWords.GhostHelper({
    projectId: <ID>
  })">
</script>

Custom position

<script async defer src="https://proxy.beyondwords.io/npm/@beyondwords/ghost-helper@latest/dist/umd.js"
  onload="new BeyondWords.GhostHelper({
    projectId: <ID>,
    target: '.custom-target',
  })">
</script>

Custom styles

<style>
    #beyondwords-player {
        margin: 16px 0;
    }
</style>
<script async defer src="https://proxy.beyondwords.io/npm/@beyondwords/ghost-helper@latest/dist/umd.js"
  onload="new BeyondWords.GhostHelper({
    projectId: <ID>
  })">
</script>

Player reference

const helper = new BeyondWords.GhostHelper({
  projectId: <ID>
});
await helper.playerLoader;
helper.player.addEventListener("<any>", console.log);

Other

For further customization you can refer to the BeyondWords Player documentation as the arguments of the GhostHelper constructor matches the BeyondWords Player constructor.

Development

Prerequisites

To work on the project you must have installed:

• Node.js 16 or higher

• npm 8 or higher

• npm dependencies:

  npm install
  

Build

The build script will produce artifacts in the /dist directory, using Vite.

The build artifact is a single js file using the umd format.

npm run build

Lint

The lint script does a full static analysis of the source code, using ESLint.

npm run lint

Release

A new version of the Ghost Helper will be published automatically to NPM using the release Github Actions workflow on each new published Github release.

License

BeyondWords Ghost Helper is MIT licensed.