etiennedel/TypeScript Documentation Generator
Automatically generates documentation for TypeScript codebases
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit May 27, 2025
- License
- MIT
Pinned Snippet
uses: etiennedel/aitechdocgen@8b7ea3ef4a666986351d87e8213940e6603d1b9c # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| claude_api_key | Claude API key for generating documentation | yes | — |
| github_token | GitHub token for accessing PR files and creating commits | yes | ${{ github.token }} |
| file_extensions | Comma-separated list of file extensions to process (e.g., .ts,.tsx) | no | .ts,.tsx |
| pr_title_prefix | Prefix for the commit message | no | docs: |
| docs-directory | Directory where documentation will be generated | no | docs |
| entry-points | Comma-separated list of entry point files for TypeDoc | yes | — |
| tsconfig | Path to tsconfig.json file | no | tsconfig.json |
| plugins | Comma-separated list of TypeDoc plugins to use | no | — |
| theme | TypeDoc theme to use | no | default |
| project-name | Name of the project for documentation | no | — |
| exclude-private | Exclude private members from documentation | no | false |
| exclude-protected | Exclude protected members from documentation | no | false |
| exclude-externals | Exclude external modules from documentation | no | false |
| exclude-internal | Exclude members marked as @internal from documentation | no | false |
| readme | Path to README file to include in documentation | no | README.md |
| separate-commits | Create separate commits for TSDoc comments and documentation | no | false |
Outputs
| name | description |
|---|---|
| processed_files | Number of files processed |
| updated_files | Number of files that were updated with documentation |