building.md

Building the DuckDB documentation

The site is built using Jekyll used by GitHub Pages.

Using a local Jekyll installation

Prerequisites

To install Jekyll, follow GitHub's instructions. Alternatively, install Ruby (using the version specified in the .ruby-version file), and run bundler to install the dependencies. If you are on Windows, you must then run these two commands:

gem uninstall eventmachine
gem install eventmachine --platform ruby

Syntax highlighter

We use a fork of the Rouge syntax highligher, which is extended with keywords not in standard SQL (e.g., RETURNING, ASOF). This is automatically installed by bundler.

Serving the site using a local Jekyll installation

Serve the website (latest only, archives excluded) with:

scripts/serve.sh

The website can then be browsed by going to http://localhost:4000/docs/ in your browser.

Serve the full website with:

scripts/serve-full.sh

Using Docker

Prerequisites

Install Docker.

Serving the site from Docker

For portability, we provide a Docker image.

First, build the image using:

scripts/docker-build.sh

Serve the website (latest only, archives excluded) with:

scripts/docker-serve.sh

Serve the full website with:

scripts/docker-serve-full.sh

To stop the container, run:

scripts/docker-stop.sh

With a Dev Container

If you are using a Dev Container, click the green Code button to the top right to open a new codespace with this repository initialized.