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-commons | README.md | Low-level commands, utilities, plugins, types, etc. used throughout Prezly-Slate packages |
@prezly/slate-editor | README.md | The Prezly Slate Editor |
@prezly/slate-hyperscript | README.md | Hyperscript helpers for creating Slate documents with JSX |
@prezly/slate-lists | README.md | The best Slate lists extension out there |
@prezly/slate-types | README.md | TypeScript definitions for Slate document structure used at Prezly |
In order to try changes made to the packages with the main application,
link these packages to global npm prefix by running npm link
in every of the sub-package folders:
ls packages | xargs -I{} sh -c 'cd packages/{} && npm link'
Then link these packages to the main app with npm link PACKAGE_NAME
:
npm link @prezly/slate-types \
@prezly/slate-hyperscript \
@prezly/slate-commons \
@prezly/slate-lists \
@prezly/slate-editor
There's an npm
task configured in our main application to simplify this routine:
npm run link-slate-packages
npm run bootstrap # install dependencies
npm run build # build all packages
npm run release # reinstall & rebuild everything from scratch and...
# ...and run a wizard that'll guide you through bulk-publishing the npm packages
Brought to you by Prezly.