Bashly render template for HTML form docs #678
felixlohmeier
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
There isn't a Bashly render template for HTML yet, right? I was wondering whether HTML forms might be suitable for documenting complex command line interfaces. If there are many parameters, it is convenient to be able to compile them with a mouse click. On the other hand, the oldfashioned option --help or man is available directly in the command line. There are probably other people like me who have their terminal and browser open at the same time anyway because they are surfing Stackoverflow and similar websites. For these people and CLIs with complex parameters, this template could be useful:
https://github.com/opencultureconsulting/orcli/tree/main/templates/html-form
The command is compiled live from the selection in the form using JS. Example:
https://code.opencultureconsulting.com/orcli/orcli%20export%20csv.html
https://code.opencultureconsulting.com/orcli/
Many Bashly options are included in the template, but not all of them yet. The string replacements for HTML would also need to be further refined (e.g., < to <).
I would appreciate any feedback and comments.
Beta Was this translation helpful? Give feedback.
All reactions