northcutted/Docker Documentation Generator

Automatically generate README documentation from Dockerfiles using dock-docs

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
versionVersion of dock-docs to use (e.g., v1.0.0). Defaults to latest.nolatest
configPath to configuration file. Enables YAML Mode if present.nodock-docs.yaml
outputOutput file path.noREADME.md
dry-runPrint output to stdout instead of modifying files.nofalse
nomojiDisable emojis in the output.nofalse
ignore-errorsIgnore analysis errors and continue generation.nofalse
verboseEnable verbose logging for debugging.nofalse
filePath to Dockerfile (CLI Mode only).no
imageDocker image tag to analyze (CLI Mode only).no

no outputs