Skip to content

Commit cce35d2

Browse files
committed
docs: add Astro Starlight docs site with GitHub Pages deployment
7-page docs site: Overview, Getting Started, DataFrame API, Operators, Formats, Architecture, Deployment. Built with Astro + Starlight, deployed to GitHub Pages via docs.yml workflow on push to docs/.
1 parent f18f66c commit cce35d2

13 files changed

Lines changed: 8219 additions & 0 deletions

.github/workflows/docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths: [docs/**]
7+
workflow_dispatch:
8+
9+
permissions:
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
runs-on: ubuntu-latest
20+
environment: github-pages
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- uses: actions/setup-node@v4
25+
with:
26+
node-version: 22
27+
28+
- run: cd docs && npm ci
29+
30+
- run: cd docs && npx astro build
31+
32+
- uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: docs/dist
35+
36+
- uses: actions/deploy-pages@v4

docs/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
dist/
3+
.astro/

docs/astro.config.mjs

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import { defineConfig } from "astro/config";
2+
import starlight from "@astrojs/starlight";
3+
4+
export default defineConfig({
5+
site: "https://teamchong.github.io",
6+
base: "/querymode",
7+
integrations: [
8+
starlight({
9+
title: "querymode",
10+
social: [
11+
{
12+
icon: "github",
13+
label: "GitHub",
14+
href: "https://github.com/teamchong/querymode",
15+
},
16+
],
17+
sidebar: [
18+
{ label: "Overview", slug: "index" },
19+
{ label: "Getting Started", slug: "getting-started" },
20+
{ label: "DataFrame API", slug: "dataframe-api" },
21+
{ label: "Operators", slug: "operators" },
22+
{ label: "Formats", slug: "formats" },
23+
{ label: "Architecture", slug: "architecture" },
24+
{ label: "Deployment", slug: "deployment" },
25+
],
26+
}),
27+
],
28+
});

0 commit comments

Comments
 (0)