Build docs during CI

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

astro.config.mjs

@@ -9,6 +9,7 @@ const rescriptTM = JSON.parse(
 export default defineConfig({
   srcDir: "docs",
   publicDir: "docs/public",
+  "site": "https://rescript-lang.github.io/experimental-rescript-webapi",
   integrations: [
     starlight({
       title: "Experimental WebAPI",

docs/content/docs/philosophy.mdx

@@ -53,4 +53,4 @@ Any other conversions can be performed using the `Prelude.unsafeConversation` he
 let element: element = document->Document.createElement( ~localName = "div")
 // This is potentially unsafe, as the type system cannot guarantee the conversion
 let divElement: htmlDivElement = element->Prelude.unsafeConversation
-```
+```

docs/content/docs/project-status.mdx

@@ -25,4 +25,4 @@ It might be a little daunting and rough to jump right in.
 ## Future
 
 Our goal is to make this a true community project. Consumers of the bindings should be able to contribute back to the project with minimal hassle.  
-This means that the project should be easy to understand and contribute to. Once a contribution is accepted, a new release will follow shortly.
+This means that the project should be easy to understand and contribute to. Once a contribution is accepted, a new release will follow shortly.

docs/notes.md

@@ -13,7 +13,7 @@ https://github.com/rescript-lang/rescript-lang.org/blob/4e4f9520f6fc7a0376db82a0
   --sl-color-accent-low: #4a0f14;
   --sl-color-accent: #e6484f;
   --sl-color-accent-high: #f9d5d7;
-  --sl-color-bg-nav: rgb(20, 22, 44); 
+  --sl-color-bg-nav: rgb(20, 22, 44);
 
   & starlight-theme-select {
     --sl-color-gray-1: var(--sl-color-black);

docs/styles/theme.css

@@ -30,7 +30,8 @@
     "test": "node tests/index.js",
     "build": "rewatch",
     "format": "rescript format -all && prettier --write ./docs ./tests/index.js ./package.json",
-    "docs": "astro dev"
+    "docs": "astro dev",
+    "build:docs": "astro build"
   },
   "license": "MIT",
   "dependencies": {
@@ -39,6 +40,7 @@
   "devDependencies": {
     "@astrojs/starlight": "^0.29.0",
     "astro": "^4.16.10",
+    "prettier": "^3.3.3",
     "sharp": "^0.32.5"
   }
 }