Generate markdown for documentation of all functions in a bash script.

This is my helper to parse a bash script and read its functions and their doc blocks. It generates markdown output to generate an automated documentation.

👤 Author: Axel Hahn
🧾 Source: https://github.com/axelhahn/bashdoc/
📜 License: GNU GPL 3.0
📗 Docs: see https://www.axel-hahn.de/docs/bashdoc/

Example:

The documentation of the script itself is here: bashdoc2md.sh.md

Other real life examples for rendered docs you can see here:

• bash color functions - file color.class.sh
• bash ini parser - file ini.class.sh
• bash sqlite functions - file sqlite.class.sh
• bash rest api client - file http.class.sh

A PHP script to generate a markdown doc page with all functions of a PHP class: https://github.com/axelhahn/php-classdoc