@codesyntax/volto-featured-block
v0.8.0
Published
@codesyntax/volto-featured-block: Volto add-on
Downloads
43
Readme
volto-featured-block
Volto add-on to create pages with arbitrary content based on a simple schema (title + image + text), that can be extended using schemaEnhancers and that support variations. The content of the block is not based in some other content of the site (for instance in core Volto's Teaser block content comes initially from a given content of the site).
This block is intended to build front pages or landing pages where usually a lot of simple content need to be added and that content is not coming from existing content.
It provides extension mechanisms using schemaExtenders and variations to add new templates or fields to it.
Installation
Add this addon to your project's dependencies:
dependencies: {
'@codesyntax/volto-featured-block": "*"
}
Features
Demo GIF
Getting started
Try volto-featured-block with Docker
Get the latest Docker images
docker pull plone docker pull plone/volto
Start Plone backend
docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
Start Volto frontend
docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@codesyntax/volto-featured-block" plone/volto
Go to http://localhost:3000
Add volto-featured-block to your Volto project
Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone
Start Volto frontend
If you already have a volto project, just update
package.json
:"addons": [ "@codesyntax/volto-featured-block" ], "dependencies": { "@codesyntax/volto-featured-block": "^1.0.0" }
If not, create one:
npm install -g yo @plone/generator-volto yo @plone/volto my-volto-project --addon @codesyntax/volto-featured-block cd my-volto-project
Install new add-ons and restart Volto:
yarn yarn start
Go to http://localhost:3000
Happy editing!
Release
See RELEASE.md.
How to contribute
See DEVELOP.md.
Copyright and license
See LICENSE.md for details.