Merge pull request #638 from derbyjs/update-jsdoc

Add Typedoc generated API docs

.github/workflows/docs-gh-pages.yml

@@ -33,6 +33,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Build with Typedoc
+        run: npm i && npm run docs
       - name: Setup Ruby
         uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
         with:

.gitignore

@@ -3,3 +3,4 @@
 node_modules
 .vscode
 dist/
+docs/api/

docs/_config.yml

@@ -40,6 +40,8 @@ markdown: kramdown
 theme: just-the-docs
 color_scheme: derby-light # just-the-docs theme customization
 permalink: /:path/:name
+keep_files:
+  - api/
 
 # just-the-docs customization
 callouts:
@@ -64,6 +66,14 @@ defaults:
     values:
       render_with_liquid: true
 
+nav_external_links:
+  - title: Derby API
+    url: /api
+    opens_in_new_tab: true
+  - title: Racer API
+    url: https://derbyjs.github.io/racer
+    opens_in_new_tab: true
+
 # Exclude from processing.
 # The following items will not be processed, by default.
 # Any item listed under the `exclude:` key here will be automatically added to

package.json

@@ -37,6 +37,7 @@
   "scripts": {
     "build": "node_modules/.bin/tsc",
     "checks": "npm run lint && npm test",
+    "docs": "npx typedoc",
     "lint": "npx eslint src/**/*.ts test/**/*.js",
     "lint:ts": "npx eslint src/**/*.ts",
     "lint:fix": "npm run lint:ts -- --fix",
@@ -79,6 +80,9 @@
     "racer": "^v2.0.0-beta.11",
     "sinon": "^18.0.0",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-mdn-links": "^3.1.28",
+    "typedoc-plugin-missing-exports": "^2.2.0",
     "typescript": "~5.1.3"
   },
   "peerDependencies": {

src/Controller.ts

@@ -11,6 +11,9 @@ export class Controller<T = DefualtType> extends EventEmitter {
   dom: Dom;
   app: App;
   page: Page;
+  /**
+   * Model scoped to this instance's "private" data.
+   */
   model: ChildModel<T>;
   markerNode: Node;