Skip to content

Volto Table of Contents block, a more powerful alternative to the default TOC block

License

Notifications You must be signed in to change notification settings

eea/volto-block-toc

Repository files navigation

volto-block-toc

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto add-on

Features

Demo GIF

Getting started

Try volto-block-toc with Docker

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

Go to http://localhost:3000

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

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