Skip to content
Shdoc
Documentation
A documentation generator that creates Markdown API docs from Bash/Zsh shell scripts by parsing special annotations.
Awk
·
Latest v1.4 · 1mo ago
Security brief →
Features
-
Parses specially‑formatted comments (annotations) in shell files
-
Generates a ready‑to‑use Markdown document describing functions, options, arguments, exit codes and I/O
-
Supports section grouping, deprecation notes and cross‑references
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
View on GitHub
Search tools, categories, lists, and users
Use ↑↓ to navigate, Enter to open, Esc to close
No results for ""
⌘K to open
↑↓ navigate
⏎ open