README

Allows to create online presentations in Pimcore using reveal-js.

Installation

Require the bundle

composer require teamneusta/pimcore-presentation-bundle

Enable the bundle

Add the Presentation Bundle to your config/bundles.php:

Neusta\Pimcore\PresentationBundle\NeustaPimcorePresentationBundle::class => ['all' => true],

Install the bundle

bin/console pimcore:bundle:install NeustaPimcorePresentationBundle

Install reveal.js

After the Bundle is installed it is required to manually install reveal-js

cd vendor/teamneusta/pimcore-presentation-bundle/public
curl -OL https://github.com/hakimel/reveal.js/archive/master.zip
unzip master.zip
rm master.zip

Usage

Create new Pimcore document pages using the Document Types offered by this bundle. See documentation for more details

Configuration

The bundle provides a handful of simple areabricks for creating presentations. When the bundle is used together with other bundles, there may be collisions of areabrick names or you may simply not be interested in using the default bricks. It is possible to disable the included areabricks with the following configuration

neusta_pimcore_presentation:
    bricks: false

Contribution

Feel free to open issues for any bug, feature request, or other ideas.

Please remember to create an issue before creating large pull requests.

Local Development

To develop on local machine, the vendor dependencies are required.

bin/composer install

We use composer scripts for our main quality tools. They can be executed via the bin/composer file as well.

bin/composer cs:fix
bin/composer phpstan
bin/composer tests

teamneusta / pimcore-presentation-bundle

Maintainers

Details