Skip to content
Shdoc
Documentation
A documentation generator that creates Markdown API docs from bash/zsh/sh scripts by parsing annotations
Awk
·
Latest v1.4 · 2d ago
Security brief →
Features
-
Extracts structured comments (annotations) from shell script source files
-
Generates readable Markdown API documentation for functions, options, arguments, exit codes, and I/O
-
Supports project‑level metadata (@name, @brief, @description) alongside per‑function docs
No immediate action
v1.4
Bug fix
·
Stale docblock fix
No immediate action
v1.3
Breaking risk
·
Deprecation tag + CLI tools
Weekly OSS security release digest.
The CVE patches and breaking changes that affected production tools this week. One email, every Sunday.
No spam, unsubscribe anytime.
About
Languages
Awk
·
Shell
·
Vim Script
Search tools, categories, lists, and users
Use ↑↓ to navigate, Enter to open, Esc to close
No results for ""
⌘K to open
↑↓ navigate
⏎ open
