Skip to content

eea/volto-slate-metadata-mentions

Repository files navigation

volto-slate-metadata-mentions

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto Slate Metadata Mentions

Features

Dynamically insert any Document metadata within your slate text blocks

Insert metadata

Combine multiple metadata in one slate text block

Combine multiple metadata

Apply styles

Style metadata entries

Preview metadata

Preview metadata

Easily locate and edit metadata within the right sidebar

Edit

Upgrade

Upgrading to 6.x

This version requires: @plone/volto >= 16.0.0.alpha.15 (volto-slate part of Volto Core).

See also

Getting started

Try volto-slate-metadata-mentions with Docker

  git clone https://github.com/eea/volto-slate-metadata-mentions.git
  cd volto-slate-metadata-mentions
  make
  make start

Go to http://localhost:3000

Add volto-slate-metadata-mentions 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-slate-metadata-mentions"
    ],
    
    "dependencies": {
        "@eeacms/volto-slate-metadata-mentions": "*"
    }
  • If not, create one:

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --canary --addon @eeacms/volto-slate-metadata-mentions
    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)