Documenting commands # or $ before sudo?
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
undefined
$ some cool command
Run command as root/superuser with sudo
undefined
# 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
undefined
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?