scala-cli icon indicating copy to clipboard operation
scala-cli copied to clipboard

`$` prefix signs shouldn't be inserted before example outputs in terminal examples

Open Gedochao opened this issue 3 years ago • 1 comments

Describe the bug

The expected outputs in our bash code block examples in docs aren't rendered properly. Unnecessary $ characters are being added.

To Reproduce

Currently, the $ character is being inserted before every line of code in our docs' terminal examples (screenshot from basics.md below.

image

What's interesting, when running yarn run start from my local machine, the $ characters seem to be completely missing.

image

Expected behaviour $ characters should only be inserted before non-output (uncommented) lines in bash code blocks in our docs.

Gedochao avatar Jun 01 '22 13:06 Gedochao

@romanowski suggested we rely on the ChainedSnippets UI component, which is used in the Getting Started guide. Looks like that'd solve the issue.

Gedochao avatar Jun 02 '22 06:06 Gedochao