bugs5382/TypeDoc Pages (versioned)
Build versioned TypeDoc docs (@shipgirl/typedoc-plugin-versions) and publish them to GitHub Pages.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | Token used to read the publish branch and deploy (usually secrets.GITHUB_TOKEN). | yes | — |
| versions | Preserve version history: restore the previously published docs before building so @shipgirl/typedoc-plugin-versions appends the new version. Set to 'false' for a single-version site that is replaced on each deploy. | no | true |
| node-version | Node.js version used to build the docs. | no | lts/* |
| docs-dir | Directory TypeDoc writes to (must match the `out` in typedoc.json). | no | docs |
| publish-branch | Branch the rendered site is published to (the Pages source). | no | gh-pages |
| install-command | Command that installs dependencies before building. | no | npm ci --ignore-scripts --legacy-peer-deps |
| build-command | Command that runs TypeDoc. | no | npm run typedoc |
Outputs
no outputs