j-ellette/AccuDoc - Auto Documentation Generator
Automatically scan and generate comprehensive documentation for your repository
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| repository-path | Path to the repository to scan (default: current directory) | no | . |
| output-file | Output documentation file path | no | docs/DOCUMENTATION.md |
| template | Documentation template (default, minimal, detailed, api, readme, student) | no | default |
| format | Output format (markdown, html, txt, pdf, site) | no | markdown |
| theme | HTML theme (default, dark, minimal, corporate) | no | default |
| markdown-flavor | Markdown flavor (github, gitlab, commonmark) | no | github |
| no-cache | Disable caching for fresh scan | no | false |
| health-check | Run project health check and output score | no | false |
| quality-check | Run quality analysis with benchmarking | no | false |
| coverage-threshold | Minimum documentation coverage percentage (0-100, fails if below) | no | 0 |
| fail-on-warnings | Fail if documentation warnings are found | no | false |
| pr-comment | Post results as PR comment (requires GITHUB_TOKEN) | no | false |
Outputs
| name | description |
|---|---|
| documentation-file | Path to generated documentation |
| health-score | Project health score (0-100) |
| coverage-score | Documentation coverage percentage |
| quality-score | Documentation quality score (0-100) |