Documentation: code snippets could be syntax-highlighted

[webbedspace]

Related problem

Consider as an example something like Elvish's documentation. There, the code snippets are syntax-highlighted in HTML to better aid reading comprehension.

Describe the solution you'd like

If you can hook up a basic syntax-highlighting method, lining up with nushell's language, to whatever you use to generate the docs, that'd definitely spruce things up.

Describe alternatives you've considered

No response

Additional context and details

No response

[fdncred]

Thanks for the suggestion. We would accept a PR for this change.

[webbedspace]

Actually, I've just noticed something strange: some pages are syntax-highlighted, like https://www.nushell.sh/book/commands/where.html, but most of them are not. This means the functionality for syntax-highlighting already exists, but isn't being used for every page… right?

[sholderbach]

Transferring this issue to https://github.com/nushell/nushell.github.io as the long text documentation is written there and the generation script for the command docs lives there as well.

I think we don't have a markdown integration for exact syntax highlighting yet, but we use a good enough approximation. Maybe checkout what markdown language extension is used and transfer that over for consistency:

``` language
code

[fdncred]

I'm wondering if we could do something like some | pipe | line | nu-highlight | to html to get some better syntax highlighting in markdown. I'm not sure html is even supported?

[fdncred]

closed by #1078