Merge pull request #75 from retorquere/docs

generate documentation and publish to github pages

.github/workflows/github-page.yml

@@ -0,0 +1,57 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  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:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up node
+        uses: actions/setup-node@v4
+
+      - name: Install NPM packages
+        run: npm ci
+
+      - name: Build all workspaces
+        run: npm run build -ws
+
+      - name: Generate documentation
+        run: npm run docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,4 +1,5 @@
 dist
+docs
 node_modules
 tsconfig.tsbuildinfo
 debugging

package.json

@@ -9,6 +9,7 @@
         "./packages/*"
     ],
     "scripts": {
+        "docs": "typedoc",
         "build": "npm run build -ws",
         "clean": "npm run clean -ws",
         "package": "npm run package -ws",
@@ -40,6 +41,7 @@
         "remark-stringify": "^10.0.3",
         "rimraf": "^5.0.5",
         "ts-morph": "^19.0.0",
+        "typedoc": "^0.25.8",
         "typescript": "^5.2.2",
         "vitest": "^0.34.3"
     },

packages/unified-latex-builder/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-cli/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-ctan/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-lint/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-prettier/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-to-hast/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-to-mdast/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-types/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-align/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-argspec/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-arguments/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-catcode/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-comments/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-environments/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-glue/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-html-like/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-ligatures/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-macros/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-match/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-packages/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-parse/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-pegjs/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-pgfkeys/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-print-raw/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-render-info/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-replace/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-scan/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-split/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-to-string/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-trim/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex-util-visit/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

packages/unified-latex/typedoc.json

@@ -0,0 +1 @@
+{ "extends": ["../../typedoc.base.json"], "entryPoints": ["index.ts"]}

typedoc.base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true
+}

typedoc.json

@@ -0,0 +1,6 @@
+{
+  "entryPoints": ["packages/*"],
+  "name": "Unified LaTeX",
+  "entryPointStrategy": "packages",
+  "includeVersion": false
+}