Skip to content

kuzudb/kuzudb.github.io

Kùzu Website

This repository hosts the source code for Kùzu website.

Test Locally

This website is built using Jekyll. To test the website locally, you need to have Ruby installed. You can follow the instructions here to install Ruby and Jekyll.

After installing Ruby and Jekyll, you can run the following commands to test the website locally:

bundle install
bundle exec jekyll serve

Alternatively, you can use the following Docker command to test the website locally:

docker compose up --build 

Add Content

API Docs

The API docs are generated by a CI pipeline. The CI pipeline will automatically generate the docs from comments and create a pull request in this repository. To update API docs, please update the corresponding comments in Kùzu repo and run "Generate-Docs" pipeline.

Contributing

We welcome contributions to Kùzu website. If you are interested in contributing to Kùzu website, please read our Contributing Guide.