Merge pull request #65 from dont-code/workflow

features: api docs

Author: gcollin

.github/workflows/doc-update.yml

@@ -26,11 +26,13 @@ jobs:
           node-version: 24
       - name: Install pandoc
         run: sudo apt-get update && sudo apt-get install -y pandoc
-      - name: Install docs dependencies
-        working-directory: ./docs
+      - name: Install monorepo dependencies
         run: |
           npm install -g pnpm@latest
-          pnpm install
+          node common/scripts/install-run-rush.js install
+      - name: Install docs dependencies
+        working-directory: ./docs
+        run: pnpm install
       - name: Generate API docs and website
         working-directory: ./docs
         run: pnpm docs:generate

docs/generate-typedoc.sh

@@ -40,6 +40,15 @@ MATOMO="$SCRIPT_DIR/matomo-script.html"
 MATOMO_OPTS=""
 [ -f "$MATOMO" ] && MATOMO_OPTS="-H $MATOMO"
 
+# Inject Matomo analytics into all API HTML pages
+if [ -f "$MATOMO" ]; then
+  echo "  Injecting Matomo analytics into API pages..."
+  find "$API_OUT" -name '*.html' | while IFS= read -r f; do
+    sed -i "/<\/head>/r $MATOMO" "$f"
+  done
+  echo "  Matomo injected into API pages."
+fi
+
 # Use-case files in order: number|filename(no ext)|title
 guides_list() {
   cat <<LIST

docs/ng-xtend-website/index.html

@@ -296,9 +296,8 @@ <h1 id="ng-xtend-logo-ng-xtend-framework"><img src="docs/logos/logo-xtend-angula
     <a href="#key-features">Features</a>
     <a href="#see-it-in-action">Demos</a>
     <a href="#quick-start">Quick start</a>
-    <a href="#getting-started">Developer guide</a>
     <a href="api/index.html">API docs</a>
-    <a href="guides/index.html">Guides</a>
+    <a href="guides/index.html">Developer's Guides</a>
   </div>
 
   <div class="hero-meta">

docs/tsconfig.typedoc.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "bundler",
+    "module": "preserve",
+    "target": "ES2022",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false
+  },
+  "include": ["./api-entrypoints/*.ts"]
+}

docs/typedoc_config.json

@@ -21,5 +21,6 @@
     "Guides": "/guides/index.html",
     "GitHub": "https://github.com/dont-code/ng-xtend"
   },
-  "customCss": "./typedoc_theme.css"
+  "customCss": "./typedoc_theme.css",
+  "tsconfig": "./tsconfig.typedoc.json"
 }