Merge pull request #32 from contentauth/add-doc-publish-wf

docs: Add docs publish workflow

Author: crandmck

.github/workflows/publish-docs.yml

@@ -0,0 +1,64 @@
+name: Build and publish docs
+
+on:
+  release:
+    types: [published]  
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'github-pages'
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: Install dependencies
+        env:
+          SKIP_RUST_BUILD: 1
+        run: pnpm install --frozen-lockfile
+
+      - name: Generate TypeDoc markdown (without modifying repo)
+        run: |
+          pnpm run build:docs
+          rm -rf docs-typedoc
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload the built site for deployment
+          path: '_site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -4,3 +4,6 @@ _site
 .jekyll-metadata
 vendor
 Gemfile.lock
+
+globals.md
+

docs/README.md

@@ -1,26 +1,12 @@
----
-title: README
-layout: none
----
+# API documentation for CAI Node.js library
 
-**@contentauth/c2pa-node**
+The files in these directories are generated by TypeDoc (except for `index.md`). The files are generated into these directories in the workflow ONLY; they are not checked in:
 
-***
+- `classes`
+- `functions`
+- `interfaces`
+- `type-aliases`
 
-# @contentauth/c2pa-node
+All the other files under `/docs` (which are checked in) are used to scaffold the Jekyll site.
 
-## [Classes](classes/index.md)
-
-{% include_relative classes/index.md %}
-
-## [Interfaces](interfaces/index.md)
-
-{% include_relative interfaces/index.md %}
-
-## [Type Aliases](type-aliases/index.md)
-
-{% include_relative type-aliases/index.md %}
-
-## [Functions](functions/index.md)
-
-{% include_relative functions/index.md %}
+The `publish-docs.yml` workflow runs TypeDoc, runs Jekyll, and publishes the resulting HTML using GitHub Pages.

docs/_includes/sidebar.html

@@ -1,9 +1,10 @@
-{%- assign readme_page = site.pages | where: "name", "README.md" | first -%}
+{%- assign sidebar = site.pages | where: "name", "globals.md" | first -%}
+
+<nav class="sidebar-content">
+  {{ sidebar.content | strip | markdownify }}
+</nav>
+
+
 
-{%- if readme_page -%}
-  <nav class="sidebar-content">
-    {{ readme_page.content | strip | markdownify }}
-  </nav>
-{%- endif -%}
 
 

docs/classes/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*.md
+
+# Don't ignore .gitignore itself
+!.gitignore
+
+# Don't ignore the README file
+!index.md