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

Recent releases

View all 2 releases →
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

Stars
346
Forks
70
Languages
Awk Shell Vim Script

Beta — feedback welcome: [email protected]