https://github.com/achianumba/shelldoc

Generate documentation from annotated shell scripts.
https://github.com/achianumba/shelldoc

Last synced: 10 days ago
JSON representation

Generate documentation from annotated shell scripts.

• Host: GitHub
• URL: https://github.com/achianumba/shelldoc
• Owner: achianumba
• License: mit
• Created: 2024-09-04T15:18:34.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T21:10:09.000Z (4 months ago)
• Last Synced: 2024-09-08T23:39:14.165Z (4 months ago)
• Language: Shell
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# shelldoc [WIP]

Generate documentation from annotated shell scripts.

## To Do

- [x] Write bundler in BASH, not Make. 

- [x] Load user configuration to overwrite defaults.

- [x] Parse command line arguments to overwrite defaults and config file.

- [ ] Extract doclets from included scripts.

- [ ] Write doclets to multiple or a single file.

- [ ] Replace ***shelldoc.conf*** with shelldoc.ini?

## Config filename

***shelldoc.conf***

## Operators

- `$` - Shell script variable to be parsed and its output used to populate/replace field

- `%` - Shelldoc variable.  (This might need a way to specify whether to parse actual value or not. E.g., to parse value into docs, close it off with %)

## Development

- clone repo & sub modules

- `. setup.bash`