Documenting commands # or $ before sudo?
This might be a stupid question, but hear me out.
I regularly document steps to install various software for myself on my wiki
More recently, I managed to use different custom text in the source markdown to prepend # and $ automatically, so commands can be copied more easily while still clarifying if it should be run as a normal user or as root.
Run command as user
$ some cool command
Run command as root/superuser with sudo
# some dangerous command
I usually remove and sudo and use the # prefix. However, in some cases, the sudo actually does something different that needs to be highlighted. For example, I might use it to execute a command as the user www-data
sudo -u www-data cp /var/www/html/html1 /var/www/html/html2
I often use $ as a prefix, but # would also make sense.
How would you prefix that line?
You are viewing a single comment
Neither because it makes it hard to copy paste. If you have to pick one then $ because # is for comments in bash.
You can just get around this by using some css tricks to display the dollar and pound signs.
It's not actually part of the command, just some css to add the prefix visually.
That's OK then. If you can double click the text field the the prefix is not highlighted, then I'm happy :)