Skip to content

prezly/slate

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

alt Prezly ❤️ Slate

Build Test Prettier

Prezly software built upon Slate.


Packages

Version License

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-lists README.md The best Slate lists extension out there
@prezly/slate-types README.md TypeScript definitions for Slate document structure used at Prezly

Development

In order to try changes made to the packages with the main application, link the root package to global npm prefix by running npm link in the root:

npm link

Then link the root package and its sub-packages to the main app with npm link @prezly/slate:

npm link @prezly/slate
rm -rf node_modules/@prezly/slate-{types,commons,lists,tables,editor}
ln -sf node_modules/@prezly/slate/packages/* node_modules/@prezly/

There's an npm task configured in our main application to simplify this routine:

npm run link-slate-packages

Setup

npm run bootstrap   # install dependencies
npm run build       # build all packages

Publishing

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.