Merge pull request #1299 from mathjax/feature/tsdoc

Add TypeDoc and Action for docs creation

Author: zorkow

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+
+# Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    name: Generate Code Docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 10
+          run_install: false
+
+      - name: Install packages
+        run: pnpm i
+
+      - name: Build docs
+        run: pnpm typedoc
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload docs folder
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package.json

@@ -152,6 +152,7 @@
     "prettier": "^3.5.3",
     "rimraf": "^5.0.10",
     "terser-webpack-plugin": "^5.3.14",
+    "typedoc": "^0.28.5",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.33.1",
     "typescript-tools": "^0.3.1",

pnpm-lock.yaml

@@ -0,0 +1,4 @@
+{
+  "extends": "./mjs.json",
+  "exclude": ["./components", "./mjs", "./cjs", "./testing"]
+}

tsconfig/docs.json

@@ -0,0 +1,9 @@
+{
+  "entryPoints": ["ts"],
+  "tsconfig": "tsconfig/docs.json",
+  "excludeNotDocumented": true,
+  "includeVersion": false,
+  "plugin": [],
+  "entryPointStrategy": "expand"
+}
+