npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@plone/blocks-conversion-tool

v0.8.2

Published

[![NPM](https://img.shields.io/npm/v/@plone/blocks-conversion-tool.svg)](https://www.npmjs.com/package/@plone/blocks-conversion-tool) [![Code analysis checks](https://github.com/plone/blocks-conversion-tool/actions/workflows/code.yml/badge.svg)](https://g

Downloads

45

Readme

Blocks Conversion Tool

NPM Code analysis checks Unit tests

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

To use a different port than 5000 if that one is already opened by another process:

PORT=6000 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"}'

Developing this package

Commit messages

This package uses @release-it/conventional-changelog to generate its CHANGELOG , so please always prefix your commit messages with:

  • feat : New features
  • fix : Bug fixes
  • refactor : Code changes and refactoring
  • chore: Maintainence tasks

Release

We use release-it to manage version releases of @plone/blocks-conversion-tool. To cut a new release run make release-package.

It is strongly recommended you first do a dry-run with make release-package-dry-run to make sure everything is in order for a new release.

After releasing the package to NPM, also create a new image tag on Docker Hub: make release-image