Shdoc generates docs for bash/zsh scripts with Awk
Documentation generator for shell scripts (bash, sh, zsh). Javadoc for shell scripts. - reconquest/shdoc
Shdoc generates docs for bash/zsh scripts with Awk launched on November 10, 2022 with 14 votes, #1,191 of 3,471 launches that month and more than 75% of that year's launches. The site was still online in September 2026, 3 years on.
In plain words
Shdoc is a documentation generator for bash and zsh scripts that uses Awk to parse code and create documentation. It extracts information from shell scripts and produces formatted docs automatically. The tool is designed for developers who write shell scripts and need to generate technical documentation without manual formatting. It launched in November 2022 and is available on GitHub.
written from the facts on this page · September 2026
Does a similar job
all alternatives →
Awkdoc: javadoc for the shell, written in Awk2023 · github.com · ▲11I like bash, and use it as often as possible. Sometimes the projects become large. I needed a tool to help generate documentation. Makes it easier to step away, come back after some time, and re-acquaint myself with the monstrosity I've wrought. `awkdoc` generates markdown documentation from in-line comments in shell scripts.
Htmldocs – Typeset and generate pdfs with HTML/CSS2024 · htmldocs.com · ▲226htmldocs is an Overleaf-style editor for typesetting documents using HTML/CSS, which provides the same benefits as LaTeX while being more accessible, customizable, and familiar. I built this because I wanted to programatically generate invoices as well as automatically tailor my resume to jobs but had no good way of generating well-formatted PDFs. I ended up building a templating engine to Chromium rendering pipeline to generate PDFs, and due to the amount of engineering effort, turned it into a tool for others that might want to do the same. There's a built-in API…
- IGI generated API documentation for all Java packages2024 · docland.io · ▲74
Hi HN! I'm excited to share a project I've been working on for the past year: Docland. It is an API documentation browser that generates documentation on demand (through compilation, not LLMs) for Java packages. Instead of relying on Javadoc, the built-in doc generator, I created the engine from scratch to give the documentations a modern look, build fast search indexes, and enable link resolution to other packages. I built Docland because I constantly found it frustrating to locate and view API definitions when programming. You'd have to Google the function/class name, skip all the SEO…
More work this month
the category →
Endless lofi beats composed live in your browser, over pixel-art nights in Paris, Tokyo, New York, Hong Kong, Sydney, San Francisco and more. Free, no sign-up.
Work · 24d ago · loficities.com
Smooth Recorder▲257Mac screen recordings that look edited when you hit stop
Work · 18d ago · smoothrecorder.com
Work · 12d ago · readrare.com
Source: Show HN post ↗
Launched alongside, November 2022
the whole month →
I made a thing! In 2014, I was holding a stack of iPhones and thought to myself: "Hey, if I had each phone display a playing card, I could click a button and they'd shuffle themselves" I pared that idea all the way down to this: trading cards made of e-ink displays. Right now, each card costs me about $20 each, but with only a bit more scale, I think I can get that down to $10. In doing this project, I learned how to design electronics and circuit boards. I learned Rust and wrote my first driver, I upped my CAD skills, 3D printed, and did my first resin casting. I generated the images on the…
Dev tools · 2022 · wyldcard.io
