Styles for shell transcripts

[alaric-dotmesh]

As a documentation author, I want to include transcripts of shell command sequences in documentation with highligthing of important parts, so I can demonstrate how things work directly.

The hugo syntax highlighter isn't the thing for this - a shell transcript is a mixture of shell commands and output from various things in various formats, so no one automatic highlighter can handle it. I'd like to be able to embed raw preformatted text and then manually emphasise parts of it.

hugo/content/api/_index.md contains some examples of a proposed markup for this in the raw pre blocks near the top. Providing CSS to make those pres look like the highlighted content blocks, with a suitable highlight (background colour?) for the em spans would probably do the trick. It might be nice to add a span class for user-entered text (eg, the typed commands) to distinguish them from command output, too?

[alaric-dotmesh]

Oooh oooh oooh there's a kbd element for precisely that: user-entered text. I've marked up the user intpu in the API docs examples with that. Maybe make it a bit bolder/brighter than the rest of the text?

[petercolesdc]

Make into shortcode

[alaric-dotmesh]

When you've made a shortcode, I'll update the API docs to use it.

[petercolesdc]

Shortcode was buggy (Hugo issue, adds a rouge

tag and cocks up formatting. Re-closing)