Skip to content

Commit 0c9fbac

Browse files
author
Topi Santakivi
committed
Add documentation site
VitePress-based docs at website/ with landing page, guides, concept explainers, real-world examples, and reference pages. Deployed to GitHub Pages via Actions workflow. Slims down README to point to the docs site. Made-with: Cursor
1 parent 2882c2b commit 0c9fbac

35 files changed

Lines changed: 5250 additions & 640 deletions

.github/workflows/docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'website/**'
8+
- '.github/workflows/docs.yml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- uses: actions/setup-node@v4
27+
with:
28+
node-version: 20
29+
cache: npm
30+
cache-dependency-path: website/package-lock.json
31+
32+
- name: Install dependencies
33+
run: npm ci
34+
working-directory: website
35+
36+
- name: Build
37+
run: npm run build
38+
working-directory: website
39+
40+
- uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: website/.vitepress/dist
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
needs: build
49+
runs-on: ubuntu-latest
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)