Skip to content

README.md

Latest commit

 

History

History
102 lines (65 loc) · 4.18 KB

README.md

File metadata and controls

102 lines (65 loc) · 4.18 KB
Raw
kitconcept, GmbH

Volto Plate.js support
(kitconcept.plate)

The Plone backend support for @kitconcept/volto-plate, the Plate.js editor add-on for Volto.

Built with Cookieplone

PyPI PyPI - Python Version PyPI - Plone Versions

GitHub contributors GitHub Repo stars

Code analysis checks

Warning

If you reached here and you are not part of the kitconcept team, please refrain from using this package in production. This package is in early and heavy development and should be used with caution in production environments. We are in the "make it work" phase and we are still figuring out the best way to implement the features we want to provide. Therefore, we can't guarantee that the package will be stable or that it will work as expected in all scenarios, and might contain technical debt, bugs, and incomplete features. It is subject to breaking changes and incomplete features and we won't support any upgrade step nor breaking change support whatsoever.

Features

Content types

  • Workspace: a folderish container for wiki content, images, and files, marked by the IWorkspaceMarker behavior
  • WikiPage: a Plate-powered page type storing Volto blocks

Discussions

  • serializers and deserializers for Plate discussions persisted as Plone comments
  • the kitconcept.plate: Discuss content permission, allowing users to add and edit their own comments in Plate editor discussions

Mentions

  • a @mentions REST API endpoint backing the editor's user mentions

Other

  • an install profile depending on plone.volto, plus an uninstall profile
  • translations for English, German, Spanish, Italian, and Brazilian Portuguese

Installation

Install kitconcept.plate with uv.

uv add kitconcept.plate

Create the Plone site.

make create-site

Contribute

Prerequisites ✅

Installation 🔧

  1. Clone this repository.

    git clone git@github.com:kitconcept/volto-plate.git
cd volto-plate/backend

  2. Install this code base.

    make install

License

The project is licensed under GPLv2.

Credits and acknowledgements 🙏

Generated using Cookieplone (2.0.0b3) and cookieplone-templates (6bdd1ef) on 2026-06-25 19:10:07.781846. A special thanks to all contributors and supporters!