A pnpm monorepo with custom Storyblok field plugins built by Lab Digital. Each plugin is a React app built with Vite into a single JavaScript bundle and deployed to the Lab Digital partner portal of Storyblok, where it can be used as a custom field type in any Storyblok space.
| Plugin | Description |
|---|---|
ct-category |
Select a category from a commercetools project. |
algolia-product-search |
Search, select and reorder products from Algolia. |
The plugins are not published to npm. Editors use them through Storyblok, so there is nothing to install in your own project.
- Node.js >= 22.12.0
- pnpm 12 (the version is pinned in
packageManagerinpackage.json) - A Storyblok personal access token to deploy
- Open the field plugin in the Storyblok partner portal and assign it to your space.
- Add a field of type Plugin to a block and select the plugin as its custom type.
- Fill in the plugin options. See the README of each plugin for its options and for the data it stores in the content field.
pnpm installRun a plugin locally and open the Storyblok Plugin Sandbox:
cd packages/ct-category
pnpm devScripts at the repository root:
| Script | Description |
|---|---|
pnpm lint |
Run Biome checks |
pnpm format |
Apply Biome fixes and formatting |
pnpm typecheck |
Run tsc in every package |
pnpm check |
Lint and typecheck (used in CI) |
pnpm -r build |
Build every plugin |
pnpm -r test |
Run the Vitest tests of every plugin |
pnpm add-plugin |
Scaffold a new plugin in packages/ with the Storyblok field plugin CLI |
The plugins are private packages, so there are no npm releases or changesets. A release is a deploy to the Storyblok partner portal:
ct-categoryis tested, built and deployed by thedeployworkflow on every push tomain.algolia-product-searchis deployed by hand. Copy.env.local.exampleto.envat the repository root, setSTORYBLOK_PERSONAL_ACCESS_TOKEN, and runpnpm run deployinpackages/algolia-product-search.