HelixQL (Legacy) Docs

Reference documentation for HelixQL, the legacy query language for HelixDB. Built with mdBook and published to GitHub Pages at https://helixdb.github.io/hql-v1-docs/.

HelixQL is deprecated in HelixDB v2. Queries are now written with the Rust DSL. These docs are kept as a reference for legacy HelixQL projects.

Structure

src/ — Markdown sources. src/SUMMARY.md defines the navigation/table of contents.
book.toml — mdBook configuration.
.github/workflows/deploy.yml — builds the book and deploys it to GitHub Pages on every push to main.

Install mdBook (requires Rust or download a prebuilt binary):

cargo install mdbook

Serve with live reload at http://localhost:3000:

mdbook serve --open

Build the static site into book/:

mdbook build

Add or edit pages as Markdown files under src/.
Register every page in src/SUMMARY.md — pages not listed there are not built into the site.