tomcdj71/Shellscribe Documentation Generator
Generate professional documentation for your shell scripts using Shellscribe
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source_path | Path to the script(s) or directory to document | yes | ./ |
| doc_path | Destination folder for generated files | no | ./docs |
| doc_filename | Base name of the generated file | no | shell_doc |
| format | Output format for the documentation | no | markdown |
| generate_index | Creates an index file for multiple scripts | no | false |
| log_level | Log level (normal, verbose) | no | normal |
| show_toc | Enables table of contents | no | false |
| show_alerts | Displays alert blocks | no | false |
| show_shellcheck | Displays shellcheck directives | no | false |
| shellcheck_display | Presentation style for shellcheck results (table, sequential) | no | sequential |
| highlight_code | Enables syntax highlighting | no | true |
| highlight_language | Language for example code highlighting | no | bash |
| example_display | Presentation style for examples (tabs, sequential) | no | sequential |
| arguments_display | Presentation style for arguments (table, sequential) | no | sequential |
| traverse_symlinks | Follow symbolic links when processing directories | no | true |
| linkify_usernames | Convert GitHub usernames to links | no | false |
| version_placement | Where to display version info (about, filename) | no | about |
| copyright_placement | Where to display copyright info (about, footer) | no | about |
| license_placement | Where to display license info (about, footer) | no | about |
| configuration_file | Path to custom configuration file | no | "" |
Outputs
no outputs