Installing

Quick Start

Choose the option that works best for you:

Nix

• Install Nix using these instructions.
• Run nix profile install github:srid/emanote ¹

No Nix? Use containers

If you prefer Docker/Podman or don’t want to install Nix:

# Run live server
podman run -it --rm \
  -p 8080:8080 \
  -v ./docs:/notebook:z \
  ghcr.io/srid/emanote run -p 8080 -h 0.0.0.0

Open http://localhost:8080 to view your site. See Container Installation for more details.

Platform-specific guides

• Windows users: See Using on Windows for Windows Subsystem for Linux setup
• Advanced Nix users: See Advanced Nix Usage for Home Manager, flake-parts, and other advanced options

Testing your installation

Once installed, test Emanote with:

# Run live server
cd /path/to/notebook
emanote run

# Generate static files
mkdir /tmp/output
emanote -L /path/to/notebook gen /tmp/output