init docs

.github/workflows/build-docker.yml

@@ -31,11 +31,19 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      # Step to get the version number from CMakeLists.txt
+      - name: Get version number
+        id: get_version
+        run: |
+          VERSION=$(grep "Kuzu VERSION" kuzu/CMakeLists.txt | head -1 | grep -oE "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+")
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+
+
       # Build and push Docker image
       - name: Build and push Docker image
         uses: docker/build-push-action@v6
         with:
           push: true
           tags: |
             dylanshang/kuzu-wasm:latest
-            dylanshang/kuzu-wasm:${{ github.sha }}
+            dylanshang/kuzu-wasm:${{ env.VERSION }}

.github/workflows/docs.yaml

@@ -0,0 +1,62 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy docs site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          path: docs
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: yarn install # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: yarn build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -10,6 +10,14 @@
   <a href="https://github.com/unswdb/kuzu-wasm/actions">
     <img src="https://github.com/unswdb/kuzu-wasm/actions/workflows/shell.yml/badge.svg?branch=main" alt="Github Actions Badge">
   </a>
+    <a href="https://github.com/unswdb/kuzu-wasm/actions">
+    <img src="https://img.shields.io/docker/image-size/dylanshang/kuzu-wasm?logo=Docker" alt="Docker Badge">
+  </a>
+    </a>
+    <a href="https://github.com/unswdb/kuzu-wasm/actions">
+    <img src="https://img.shields.io/pypi/v/kuzu-wasm?color=green
+    " alt="Docker Badge">
+  </a>
 </div>
 <h1></h1>
 
@@ -20,10 +28,46 @@ Kùzu-Wasm brings kuzu to every browser thanks to WebAssembly.
 
 Try it out at [kuzu-shell.netlify.app](https://kuzu-shell.netlify.app).
 
+
+## Installation
+Prerequisite: [Enable Cross-Origin-isolation](https://web.dev/articles/cross-origin-isolation-guide?hl=en#enable_cross-origin_isolation)
+### CDN
+```javascript
+<script type="module">
+import kuzu_wasm from 'https://unpkg.com/@kuzu/kuzu-wasm@latest/dist/kuzu-browser.js';
+(async () => {
+    const kuzu = await kuzu_wasm();
+    window.kuzu = kuzu
+    const db = await kuzu.Database()
+    const conn = await kuzu.Connection(db)
+    await conn.execute(`CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))`)
+    await conn.execute(`CREATE (u:User {name: 'Alice', age: 35});`)
+    const res = await conn.execute(`MATCH (a:User) RETURN a.*;`)
+    const res_json = JSON.parse(res.table.toString());
+})();
+</script>
+```
+### Webpack/React/Vue
+```bash
+npm install @kuzu/kuzu-wasm
+```
+```javascript
+import kuzu_wasm from '@kuzu/kuzu-wasm';
+(async () => {
+    const kuzu = await kuzu_wasm();
+    const db = await kuzu.Database()
+    const conn = await kuzu.Connection(db)
+    await conn.execute(`CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))`)
+    await conn.execute(`CREATE (u:User {name: 'Alice', age: 35});`)
+    const res = await conn.execute(`MATCH (a:User) RETURN a.*;`)
+    const res_json = JSON.parse(res.table.toString());
+})();
+```
+
 ## Build from source
 ```shell
 git clone https://github.com/unswdb/kuzu-wasm.git --recursive
-make
+make package
 ```
 
 ## Repository Structure
@@ -34,5 +78,5 @@ make
 | [@kuzu/kuzu-wasm](/packages/kuzu-wasm)             | Javascript API | Javascript |
 | [@kuzu/kuzu-shell](/packages/kuzu-shell) | Cypher Shell      | React       |
 
-## Debug
-I debug using Chrome DevTools as described in this [blog post](https://developer.chrome.com/blog/wasm-debugging-2020/), which takes a few steps to set up. The first is to install the [C/C++ DevTools Support Extension](https://chrome.google.com/webstore/detail/cc%20%20-devtools-support-dwa/pdcpmagijalfljmkmjngeonclgbbannb) and to enable **WebAssembly Debugging: Enable DWARF support** in the DevTools settings.
+## License
+By contributing to kuzu-wasm, you agree that your contributions will be licensed under the [MIT License](LICENSE.txt).

docs/.gitignore

@@ -0,0 +1,13 @@
+pids
+logs
+node_modules
+npm-debug.log
+coverage/
+run
+dist
+.DS_Store
+.nyc_output
+.basement
+config.local.js
+basement_dist
+.vitepress/cache

docs/.vitepress/config.mts

@@ -0,0 +1,47 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Kùzu Wasm",
+  description: "WebAssembly version of Kùzu database",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Guide', link: '/guide/what-is-kuzu-wasm', activeMatch: '/guide/' },
+    ],
+
+    sidebar: {
+      '/guide/': [
+        {
+          base: '/guide/',
+          items: [
+            {
+              text: 'Introduction',
+              collapsed: false,
+              items: [
+                { text: 'What is Kuzu Wasm?', link: 'what-is-kuzu-wasm' },
+                { text: 'Prerequisite', link: 'prerequisite' },
+                { text: 'Getting Started', link: 'getting-started' },
+              ]
+            },
+            {
+              text: 'Import data',
+              collapsed: false,
+              items: [
+                { text: 'Updating...', link: '' },
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2024-present Dylan Shang'
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/unswdb/kuzu-wasm' }
+    ]
+  }
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/guide/Debug.md

@@ -0,0 +1,2 @@
+## Debug
+I debug using Chrome DevTools as described in this [blog post](https://developer.chrome.com/blog/wasm-debugging-2020/), which takes a few steps to set up. The first is to install the [C/C++ DevTools Support Extension](https://chrome.google.com/webstore/detail/cc%20%20-devtools-support-dwa/pdcpmagijalfljmkmjngeonclgbbannb) and to enable **WebAssembly Debugging: Enable DWARF support** in the DevTools settings.