https://github.com/coderofsalvation/bashdoc
simple portable documentation generator for any sourcecode using simply bash & markdown
https://github.com/coderofsalvation/bashdoc
Last synced: 12 months ago
JSON representation
simple portable documentation generator for any sourcecode using simply bash & markdown
- Host: GitHub
- URL: https://github.com/coderofsalvation/bashdoc
- Owner: coderofsalvation
- License: gpl-2.0
- Created: 2014-04-09T21:06:08.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2020-05-28T18:17:18.000Z (about 6 years ago)
- Last Synced: 2025-04-12T20:12:03.035Z (about 1 year ago)
- Language: Shell
- Homepage:
- Size: 222 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
bashdoc
=======
simple portable documentation generator for sourcecode using simply bash & markdown.
Need a simple doc-chain without fancyness?
### Installation
$ git clone https://github.com/coderofsalvation/bashdoc.git
$ cli/build docs
bashing down doc/menu.md
bashing down doc/changes.md
bashing down doc/dirstructure.md
bashing down doc/functions.md
bashing down doc/index.md
Now browse to /doc and voila!
### Screenshots
### Why
To easily drop-in a doc-chain into your projects which is:
* portable
* deadsimple
* easy to extend
* for any language, just fiddle with the regexes for other languages
* use inline bash in markdown (templating language)
* easy to trigger from githooks (on deployment e.g.)
I know there are fancy other packages, but sometimes I need the bare minimum.
The example scans all php files from the root, but with a bit of bashfu you can tailor it to your own needs.
### Credits
* [bashdown](https://github.com/coderofsalvation/bashdown)
* [markdown.bash](https://github.com/chadbraunduin/markdown.bash)
* GNU coreutils
* GNU bash