@plone/blocks-conversion-tool

Blocks Conversion Tool

Introduction

This package implements a server with a simple API to convert HTML (as used in Plone Classic) to Blocks (as used on Volto).

Starting the server

From source

git clone https://github.com/plone/blocks-conversion-tool.git
cd blocks-conversion-tool
yarn install
yarn start

With Docker

docker run -it -p 5000:5000 plone/blocks-conversion-tool:latest

Usage

HTML to Blocks (Slate)

Slate is going to be the default text block for Plone 6, to convert HTML to an array of blocks call the service passing the HTML as shown below:

curl -i -X POST http://localhost:5000/html -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"html": "<p>Hello world!</p>"}'

HTML to Blocks (DraftJS)

Draft-JS is the legacy default text block used in Volto.

curl -i -X POST http://localhost:5000/html -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"html": "<p>Hello world!</p>", "converter": "draftjs"}'

Changelog

0.3.2 (2022-02-18)

Bug Fixes

• Remove from the src the /@@images suffix (bare Plone uses it, but then it's not supported in the default Volto block. (d241cbc)

Changes

• Do not issue a in slate, always link types. This is consistent with how is the default behavior in slate. (5951c59)

Maintenance

• Add CI yarn test command (f57da58)
• Add make release-package and make release-package-dry-run (dfb1e02)
• Improve Makefile for building and releasing the Docker image (e79360e)
• Lint fixes (7b62b6c)