Awesome

volto-description-block

Volto Description block based on volto-slate that automatically strips HTML and updates Document description metadata field.

Features

Getting started

Try volto-description-block with Docker

  git clone https://github.com/eea/volto-description-block.git
  cd volto-description-block
  make
  make start

Go to http://localhost:3000

Add volto-description-block to your Volto project

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

   docker compose up backend
   

2. Start Volto frontend

• If you already have a volto project, just update package.json:

  "addons": [
      "@eeacms/volto-description-block"
  ],
  
  "dependencies": {
      "@eeacms/volto-description-block": "*"
  }
  

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-description-block
  cd my-volto-project
  

1. Install new add-ons and restart Volto:

   yarn
   yarn start
   

2. Go to http://localhost:3000

3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)