Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-anchors

Slug based anchor links for volto blocks
https://github.com/eea/volto-anchors

javascript plone react volto

Last synced: about 2 months ago
JSON representation

Slug based anchor links for volto blocks

Host: GitHub
URL: https://github.com/eea/volto-anchors
Owner: eea
License: mit
Created: 2023-01-30T14:40:15.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-04-22T12:13:31.000Z (9 months ago)
Last Synced: 2024-04-22T13:33:37.959Z (9 months ago)
Topics: javascript, plone, react, volto
Language: JavaScript
Homepage:
Size: 6.28 MB
Stars: 0
Watchers: 25
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-anchors - Slug based anchor links for volto blocks (Addons / Layout addons)

README

        # volto-anchors

[![Releases](https://img.shields.io/github/v/release/eea/volto-anchors)](https://github.com/eea/volto-anchors/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-anchors%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-anchors/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-anchors%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-anchors/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-anchors-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-anchors-develop)

[Volto](https://github.com/plone/volto) add-on

## Features

![Anchors](https://raw.githubusercontent.com/eea/volto-anchors/master/docs/volto-anchors.gif)

## Getting started

### Try volto-anchors with Docker

      git clone https://github.com/eea/volto-anchors.git

      cd volto-anchors

      make

      make start

Go to http://localhost:3000

### Add volto-anchors to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

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

   ```JSON

   "addons": [

       "@eeacms/volto-anchors"

   ],

   "dependencies": {

       "@eeacms/volto-anchors": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-anchors

   cd my-volto-project

   ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-anchors/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-anchors/blob/master/DEVELOP.md).

## Copyright and license

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

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-anchors/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)