Skip to content

prezly/slate

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
May 7, 2024
May 7, 2024
Jan 15, 2025
Nov 16, 2021
Jan 15, 2025
May 7, 2023
May 8, 2023
May 7, 2024
May 3, 2023
May 3, 2023
Jan 15, 2021
May 3, 2023
Jan 15, 2021
May 7, 2024
Jul 18, 2024
Jan 14, 2025
Jan 15, 2025
May 2, 2023
Jan 15, 2021
Jan 3, 2024
Nov 18, 2024
Nov 13, 2024
May 2, 2023
Dec 30, 2021

Repository files navigation

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-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

Development

In order to try changes made to the packages with the main application:

  1. Link the root package and all sub-packages via PNPM workspace:

    # pnpm-workspace.yaml
    packages:
        - "../../../slate"
        - "../../../slate/packages/*"
  2. And then install normally:

    pnpm install

Developing with the Prezly app:

The main Prezly application has a Makefile target to simplify the linking process.

  1. 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
  2. Run make link-modules (in the apps/backend folder)

  3. Build @prezly/slate repo code with pnpm build (in the @prezly/slate local working copy):

pnpm build
  1. Build or watch the backend app with pnpm build or pnpm watch (in the apps/backend folder)

Setup

pnpm install
pnpm build

Publishing

pnpm clean && pnpm install && pnpm release

Brought to you with 🤘 by Prezly.