Eclipse zenoh's Website

The website for the Eclipse zenoh project. Lives at http://zenoh.io.

Getting Started

Using Dev Container (Recommended)

The easiest way to develop the Zenoh web documentation is using VS Code Dev Containers, which provides a consistent development environment without installing Hugo locally.

Prerequisites:

• Docker installed and running
• Visual Studio Code
• Dev Containers extension for VS Code

Steps:

1. Open this repository in VS Code

2. When prompted, click "Reopen in Container" (or press F1 and select "Dev Containers: Reopen in Container")

3. VS Code will build the Docker container and set up the development environment

4. Once ready, run the development server:

   hugo server

5. Visit http://localhost:1313

Local Hugo Installation

The website should build with the latest version of Hugo, the last tested is Hugo 0.145.0. On MacOS you can install Hugo as described below, in any case refer to Hugo Documentation for installation instructioins

brew update && brew install hugo

Then, get the website running locally:

git clone https://github.com/atolab/zenoh-web
cd zenoh-web
hugo server

Then visit http://localhost:1313.

Using Docker Directly

If you prefer to use Docker without VS Code:

# Build the Docker image
docker build -f docker/Dockerfile --build-arg user=$(id -un) --build-arg uid=$(id -u) -t zenoh_web .

# Run the development server
docker run --rm -v $(pwd):/src -p 1313:1313 zenoh_web

License

This project is licensed under the Eclipse Public License 2.0 or the Apache License 2.0.

Credits

This website design is inspired from the tokio-rs website which is licensed under MIT License.