Skip to content

Commit 4fe2450

Browse files
authored
docs (#26)
* feat: bootstrap starlight docs folder * feat: add concept absurd sqlite doc * doc: add concept / durable workflow * doc: add faq / ai use disclaimer * doc: extract functions list from extension * ci: deploy docs * chore: allow debug branch * ci: drop debug
1 parent 0811374 commit 4fe2450

32 files changed

Lines changed: 7583 additions & 1 deletion

.cargo/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[alias]
2+
docs-sqlite-functions = "run -p absurd-sqlite-extension --bin extract_sqlite_functions -- --out docs-starlight/src/content/docs/reference/sqlite-functions.mdx"

.editorconfig

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ charset = utf-8
55
end_of_line = lf
66
insert_final_newline = true
77

8-
[*.ts]
8+
[*.{ts,js,tsx,jsx,mjs}]
99
indent_style = space
1010
indent_size = 2
1111

@@ -16,3 +16,9 @@ indent_size = 2
1616
[*.rs]
1717
indent_style = space
1818
indent_size = 4
19+
20+
[*.{md,mdx}]
21+
trim_trailing_whitespace = false
22+
indent_size = 2
23+
indent_style = space
24+
max_line_length = off

.github/workflows/docs-pages.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Docs (GitHub Pages)
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
- name: Setup Node
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: 20
27+
cache: npm
28+
cache-dependency-path: docs-starlight/package-lock.json
29+
- name: Configure Pages
30+
uses: actions/configure-pages@v5
31+
- name: Install D2
32+
run: curl -fsSL https://d2lang.com/install.sh | sh -s --
33+
- name: Install dependencies
34+
run: npm ci
35+
working-directory: docs-starlight
36+
- name: Build site
37+
run: npm run build
38+
working-directory: docs-starlight
39+
env:
40+
SITE: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/
41+
BASE: /${{ github.event.repository.name }}/
42+
- name: Upload Pages artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: docs-starlight/dist
46+
47+
deploy:
48+
needs: build
49+
runs-on: ubuntu-latest
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)