northcutted/Docker Documentation Generator
Automatically generate README documentation from Dockerfiles using dock-docs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Version of dock-docs to use (e.g., v1.0.0). Defaults to latest. | no | latest |
| config | Path to configuration file. Enables YAML Mode if present. | no | dock-docs.yaml |
| output | Output file path. | no | README.md |
| dry-run | Print output to stdout instead of modifying files. | no | false |
| nomoji | Disable emojis in the output. | no | false |
| ignore-errors | Ignore analysis errors and continue generation. | no | false |
| verbose | Enable verbose logging for debugging. | no | false |
| file | Path to Dockerfile (CLI Mode only). | no | — |
| image | Docker image tag to analyze (CLI Mode only). | no | — |
Outputs
no outputs