API docs.

Author: voxelstack

.github/workflows/typedoc.yml

@@ -0,0 +1,38 @@
+name: API docs
+on:
+    pull_request:
+    push:
+
+jobs:
+    # The main documentation is built by readthedocs.
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - run: corepack enable
+            - uses: actions/checkout@v5
+            - uses: actions/setup-node@v6
+              with:
+                  cache: "pnpm"
+            - name: Build
+              run: |
+                  pnpm install
+                  pnpm exec typedoc
+            - name: Upload
+              id: deployment
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: ./typedoc
+    deploy:
+        permissions:
+            contents: read
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -3,3 +3,5 @@ dist
 
 .nyc_output
 coverage
+
+typedoc

package.json

@@ -54,6 +54,7 @@
         "sinon": "^21.0.1",
         "sinon-chai": "^4.0.1",
         "tsx": "^4.21.0",
+        "typedoc": "^0.28.15",
         "typescript": "^5.9.3",
         "typescript-eslint": "^8.52.0"
     },

pnpm-lock.yaml

@@ -2,6 +2,23 @@ import { CeresElement } from "./element";
 import type { Children, Tag } from "./types";
 
 export { CeresElement } from "./element";
+
+/**
+ * Creates a ceres element.
+ * Shorthand for `new CeresElement()`.
+ * @see {@link CeresElement}
+ *
+ * @example
+ * ```typescript
+ * $element("span", {}, ceres)
+ * .mount(root);
+ * ```
+ *
+ * @param tag The HTML tag.
+ * @param props Element attributes.
+ * @param children A single string or a list of child elements.
+ * @returns A new CeresElement.
+ */
 export function $element<const ElementTag extends Tag>(
     tag: ElementTag,
     props: unknown,