Prezly software built upon Slate.
Every package has been implemented with TypeScript.
Prezly-specific packages mention Prezly in the description. All other packages should be generic and reusable in any project.
Package | Readme | Description |
---|---|---|
@prezly/slate-types | README.md | TypeScript definitions for Slate document structure used at Prezly |
@prezly/slate-commons | README.md | Low-level commands, utilities, plugins, types, etc. used throughout Prezly-Slate packages |
@prezly/slate-lists | README.md | The best Slate lists extension out there |
@prezly/slate-tables | README.md | The best Slate tables extension out there |
@prezly/slate-editor | README.md | The Prezly Slate Editor |
In order to try changes made to the packages with the main application:
Link the root package and all sub-packages via PNPM workspace:
# pnpm-workspace.yaml
packages:
- "../../../slate"
- "../../../slate/packages/*"
And then install normally:
pnpm install
The main Prezly application has a Makefile target to simplify the linking process.
Link the Slate repo and its subpackages with symlinks (adjust the paths to match your directory structure):
cd apps/backend/linked_modules
ln -s ../../../../slate
ln -s ../../../../slate/packages/slate-types
ln -s ../../../../slate/packages/slate-commons
ln -s ../../../../slate/packages/slate-lists
ln -s ../../../../slate/packages/slate-tables
ln -s ../../../../slate/packages/slate-editor
Run make link-modules
(in the apps/backend
folder)
Build @prezly/slate
repo code with pnpm build
(in the @prezly/slate
local working copy):
pnpm build
Build or watch the backend app with pnpm build
or pnpm watch
(in the apps/backend
folder)
pnpm install
pnpm build
pnpm clean && pnpm install && pnpm release
Brought to you with :metal: by Prezly.