eclipse-edc.github.io website

This repository contains project-wide documentation.

Running the website locally

Building and running the site locally requires a recent extended version of Hugo. You can find out more about how to install Hugo for your environment in our Getting started guide.

hugo server

Running a container locally

You can run the website inside a Docker container, the container runs with a volume bound to the root folder.

1. Build the docker image

   docker compose up --build

2. Verify that the service is working.

   Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the homepage. You can now make changes to the docs and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C.

To remove the produced images run:

docker compose rm

For more information see the [Docker Compose documentation][].

Broken Link Checking

This repository includes GitHub Actions workflows to check for broken links:

• PR checks: .github/workflows/check-broken-links.yaml (runs on every PR)
• Scheduled checks: .github/workflows/check-broken-links-schedule.yaml (runs weekly)

Both workflows use lychee to detect broken links.

Configuration

• URL patterns to ignore are specified in .lycheeignore
• See .lycheeignore.md for documentation on the ignore patterns
• See .github/workflows/README.md for workflow documentation