Merge pull request #6 from rescript-lang/docs

Add initial docs

Author: nojaf

.github/workflows/ci.yml

@@ -8,6 +8,11 @@ on:
     branches:
       - main
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -36,6 +41,15 @@ jobs:
       - name: Run tests
         run: npm test
 
+      - name: Build documentation
+        run: npm run build:docs
+
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v3
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        with:
+          path: ./dist
+
       - name: get-npm-version
         id: package-version
         uses: martinbeentjes/[email protected]
@@ -61,3 +75,15 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
         run: npm publish --access public ./*.tgz --tag experimental
+
+  deploy-docs:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1,5 @@
 /node_modules/
 /lib/
 .bsb.lock
+.astro
+dist/

astro.config.mjs

@@ -0,0 +1,27 @@
+import { readFileSync } from "node:fs";
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+
+const rescriptTM = JSON.parse(
+  readFileSync("./docs/assets/rescript.tmLanguage.json", "utf-8"),
+);
+
+export default defineConfig({
+  srcDir: "docs",
+  publicDir: "docs/public",
+  "site": "https://rescript-lang.github.io/experimental-rescript-webapi",
+  integrations: [
+    starlight({
+      title: "Experimental WebAPI",
+      logo: {
+        src: "./docs/assets/rescript-logo.svg",
+      },
+      customCss: ["./docs/styles/fonts.css", "./docs/styles/theme.css"],
+      expressiveCode: {
+        shiki: {
+          langs: [rescriptTM],
+        },
+      },
+    }),
+  ],
+});