Show HN: Shdoc – javadoc for shell scripts (2019)

Category: devtools

Tags: documentation-generator, shell-scripts, awk

Score: 5.3/10 (Innovation: 4, Technical: 5, Documentation: 7, Utility: 5)

Shdoc is a documentation generator for shell scripts that parses annotations to produce Markdown API docs, akin to Javadoc for Bash. It is interesting because it fills a gap in documenting shell scripts with a structured, annotation-based approach, and is implemented in Awk.

Target audience: backend devs, devops

Repository: https://github.com/reconquest/shdoc · Awk · MIT · 343 stars

View on Hacker News