What tool/framework makes nice command line tutorials?
Post date: 2020-10-23 11:32:40
I need to author some step by step tutorials for using command line tools together. I've seen some slick frameworks that make it easy for users to copy the exact command needed to run it in the terminal and see what the output should look like but am striking out on finding such a tool.
Katacoda looks close but is overkill - I don't need containers for users to be working in, just HTML they can read to get information from, an easy way to cut shell commands verbatim, and images of what they should see if things worked correctly.
Basically I need something like this:
block of normal text explaining what the user is about to do]
block of monospaced text that's the command to run] easy button to copy the command]
image of what the results should look like]
block of normal text explaining what's significant about the results]
Repeat until the sequence of commands is complete.
block of normal text explaining a challenge for the user to solve on their own]
a hint that the user must click to see]
a second hint the user must click to see]
the solution in monospaced text (hidden until the user clicks on it)] easy button to copy the command]
image of what they should see (similarly hidden until the solution is clicked)]
block of normal text explaining the challenge (similarly hidden until the solution is clicked)]
It looks like Jeckyl might do this with some coaxing? Is there an out-of-the-box framework that does this? I'm fine writing markdown but would prefer to avoid XML.