You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Following up from some of the changes I made to the Cerebras CSL page: #601 (comment)
Some of the above changes, and other enhancements to code blocks, should be considered and applied more broadly across our docs:
Disable copy button for "sample output" blocks, using ```bash ----> ` { .bash .no-copy }, etc.
The "copy to clipboard" button just gets in the way for these types of blocks; I cant imagine any situation in which a reader would want to copy/paste the whole thing:
It could be useful to condense and make a more readable example script, when combined with explanations for each line, e.g.
Would move the below list to code line annotations directly in the script:
Remove $ prefixes when used for command line instructions
Some authors are in the habit of manually adding these for every command line. But for commands that are intended to be copied from our docs for users to run directly, the $ breaks the usefulness of copy-button, and make it harder to manually highlight and copy individual lines.
For long example sequences of shell commands and sample output intertwined, it would be messy to enable the copy button to only copy the command lines, excluding the "sample output", without breaking into separate blocks. For example:
The text was updated successfully, but these errors were encountered:
Following up from some of the changes I made to the Cerebras CSL page: #601 (comment)
Some of the above changes, and other enhancements to code blocks, should be considered and applied more broadly across our docs:
Add line numbers to more code blocks
Disable copy button for "sample output" blocks, using
```bash
----> `{ .bash .no-copy }
, etc.The "copy to clipboard" button just gets in the way for these types of blocks; I cant imagine any situation in which a reader would want to copy/paste the whole thing:
![image](https://private-user-images.githubusercontent.com/1410981/403151636-6c6f7ab8-168e-4287-aea0-c550c2deb2f8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5MDE1MTQsIm5iZiI6MTczODkwMTIxNCwicGF0aCI6Ii8xNDEwOTgxLzQwMzE1MTYzNi02YzZmN2FiOC0xNjhlLTQyODctYWVhMC1jNTUwYzJkZWIyZjgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDdUMDQwNjU0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9Y2QwMDk3MGU0NDQ3NGYzMDE0MTEyNjAxYjgyZDEwNWUyOWY3NzM4YTQ2YTg3NTZlNjUzMTIzMjRlYTFhYzBlZSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.c6r3rZbnnE0I5O0yq-vSAJnDZdQigYVZ6dX1FuBT9Tc)
It could be useful to condense and make a more readable example script, when combined with explanations for each line, e.g.
![image](https://private-user-images.githubusercontent.com/1410981/403150480-c9c46750-a2eb-4a06-9752-8b90c512dd9a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5MDE1MTQsIm5iZiI6MTczODkwMTIxNCwicGF0aCI6Ii8xNDEwOTgxLzQwMzE1MDQ4MC1jOWM0Njc1MC1hMmViLTRhMDYtOTc1Mi04YjkwYzUxMmRkOWEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDdUMDQwNjU0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MDU4MjVlODkyMzJiZmEwNDZkNDg2MGExN2M0NDQzMGFiNTFjZTk5Yzc5MDc4N2YzYjBkZDZkZGJkNDBjNzYyYiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.dmZHK-3GDqDuvG5-pedV3h2unHBYlvVS678N0HJMPQ0)
![image](https://private-user-images.githubusercontent.com/1410981/403150582-29970485-e65a-4eb4-98a7-a474dd7b12f7.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5MDE1MTQsIm5iZiI6MTczODkwMTIxNCwicGF0aCI6Ii8xNDEwOTgxLzQwMzE1MDU4Mi0yOTk3MDQ4NS1lNjVhLTRlYjQtOThhNy1hNDc0ZGQ3YjEyZjcucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDdUMDQwNjU0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MDFhODFlNjM3ZjU1MzBlMWI1NjVjZDQ4MWY5YmZhYjI5NDY3NDI4MzcwODk4M2RiYjk0ZDhlZDU0ZTc2YWEyZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.5z_uQFFZEaeqOKXe0o0IXS6LU18-xkKQhJqZtemuTXc)
Would move the below list to code line annotations directly in the script:
Long term: add a custom code superfence to prefix $ in the left margin, suggested here: squidfunk/mkdocs-material#3427
![image](https://private-user-images.githubusercontent.com/1410981/403155318-ad61ae20-fcc5-4366-8fcf-edaa5a5cebf0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5MDE1MTQsIm5iZiI6MTczODkwMTIxNCwicGF0aCI6Ii8xNDEwOTgxLzQwMzE1NTMxOC1hZDYxYWUyMC1mY2M1LTQzNjYtOGZjZi1lZGFhNWE1Y2ViZjAucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDdUMDQwNjU0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZGFhODVkMmQ4NTA3MmUzMjVhY2Y5NjIwOTNhZjg0NGY2OWFjNGE3OWRkMGM1NTBhODlkMDI3NWYwNjEyNDNjNyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.I54M5pQ8k3zwPPAkI2lWgdVFVbjHDcWbepFovMINGag)
For long example sequences of shell commands and sample output intertwined, it would be messy to enable the copy button to only copy the command lines, excluding the "sample output", without breaking into separate blocks. For example:
The text was updated successfully, but these errors were encountered: