Skip to content

Commit

Permalink
✨ Add typedocs for Interactor API docs
Browse files Browse the repository at this point in the history
With the migration to Deno and Deploy, we lost the typedocs.

This uses typedoc to generate the API docs for the core HTML and MUI
interactors.

We still haven't solved the problem of how to manage multiple
versions at the same time. I have some ideas on how that would work,
but until such time, we need to just the the API docs for the latest
version up there.
  • Loading branch information
cowboyd committed Sep 21, 2024
1 parent 12baf37 commit 6d466e0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ on:
push:
branches:
- main
- www # remove this branch once this is merged to main
paths:
- website/**
- packages/**/src/**
pull_request:
- branches:
- main

jobs:
website:
Expand Down
6 changes: 5 additions & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"private": true,
"scripts": {
"start": "docusaurus start",
"build": "docusaurus build --out-dir build/interactors && node sitemap.mjs",
"build": "yarn build:docusaurus && yarn build:sitemap && yarn build:typedocs:html && yarn build:typedocs:mui",
"build:docusaurus": "docusaurus build --out-dir build/interactors",
"build:sitemap": "node sitemap.mjs",
"build:typedocs:html": "cd ../packages/html && npx typedoc --out ../../website/build/interactors/html/api --skipErrorChecking mod.ts",
"build:typedocs:mui": "cd ../packages/material-ui && npx typedoc --out ../../website/build/interactors/mui/api --skipErrorChecking mod.ts",
"serve": "docusaurus serve"
},
"dependencies": {
Expand Down

0 comments on commit 6d466e0

Please sign in to comment.