{"id":18085033,"url":"https://github.com/coderofsalvation/bashdoc","last_synced_at":"2025-07-04T21:35:50.835Z","repository":{"id":15872611,"uuid":"18613346","full_name":"coderofsalvation/bashdoc","owner":"coderofsalvation","description":"simple portable documentation generator for any sourcecode using simply bash \u0026 markdown","archived":false,"fork":false,"pushed_at":"2020-05-28T18:17:18.000Z","size":227,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T20:12:03.035Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderofsalvation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":"https://gumroad.com/l/hGYGh"}},"created_at":"2014-04-09T21:06:08.000Z","updated_at":"2020-05-28T18:17:20.000Z","dependencies_parsed_at":"2022-08-27T03:51:17.911Z","dependency_job_id":null,"html_url":"https://github.com/coderofsalvation/bashdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/coderofsalvation/bashdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fbashdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fbashdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fbashdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fbashdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderofsalvation","download_url":"https://codeload.github.com/coderofsalvation/bashdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fbashdoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263624816,"owners_count":23490565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-31T15:09:08.570Z","updated_at":"2025-07-04T21:35:50.815Z","avatar_url":"https://github.com/coderofsalvation.png","language":"Shell","funding_links":["https://gumroad.com/l/hGYGh"],"categories":[],"sub_categories":[],"readme":"bashdoc\n=======\n\nsimple portable documentation generator for sourcecode using simply bash \u0026amp; markdown.\n\nNeed a simple doc-chain without fancyness?\n\n### Installation\n\n    $ git clone https://github.com/coderofsalvation/bashdoc.git\n    $ cli/build docs\n    \n    bashing down doc/menu.md\n    bashing down doc/changes.md\n    bashing down doc/dirstructure.md\n    bashing down doc/functions.md\n    bashing down doc/index.md\n\nNow browse to /doc and voila!\n\n### Screenshots\n\n\u003cimg alt=\"screenshot of index view\" src=\"https://raw.githubusercontent.com/coderofsalvation/bashdoc/master/examplecode/screenshot1.png\"/\u003e\n\n\u003cimg alt=\"screenshot of index view\" src=\"https://raw.githubusercontent.com/coderofsalvation/bashdoc/master/examplecode/screenshot2.png\"/\u003e\n\n\u003cimg alt=\"screenshot of index view\" src=\"https://raw.githubusercontent.com/coderofsalvation/bashdoc/master/examplecode/screenshot3.png\"/\u003e\n\n\u003cimg alt=\"screenshot of index view\" src=\"https://raw.githubusercontent.com/coderofsalvation/bashdoc/master/examplecode/screenshot4.png\"/\u003e\n\n\u003cimg alt=\"screenshot of index view\" src=\"https://raw.githubusercontent.com/coderofsalvation/bashdoc/master/examplecode/screenshot5.png\"/\u003e\n\n### Why\n\nTo easily drop-in a doc-chain into your projects which is:\n\n* portable\n* deadsimple\n* easy to extend \n* for any language, just fiddle with the regexes for other languages\n* use inline bash in markdown (templating language)\n* easy to trigger from githooks (on deployment e.g.)\n\nI know there are fancy other packages, but sometimes I need the bare minimum.\n\nThe example scans all php files from the root, but with a bit of bashfu you can tailor it to your own needs.\n\n### Credits\n\n* [bashdown](https://github.com/coderofsalvation/bashdown)\n* [markdown.bash](https://github.com/chadbraunduin/markdown.bash)\n* GNU coreutils\n* GNU bash\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderofsalvation%2Fbashdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderofsalvation%2Fbashdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderofsalvation%2Fbashdoc/lists"}