search

openservicemesh / osm-docs

a docs page for open service mesh
https://docs.openservicemesh.io
Apache License 2.0
4 stars 40 forks source link

Remove $ symbol from code blocks #375

Closed shalier closed 1 year ago

shalier commented 2 years ago

Some code blocks have the $ in front of the command such that when you copy the block it'll copy the $ as well so then the command doesn't run image

shalier commented 2 years ago

This could be fixed with https://github.com/openservicemesh/osm-docs/issues/374, it looks like the $ is used to separate the command from the example output. But not entirely sure that #374 covers every instance of a code block having a $

Santosh1176 commented 2 years ago

Hey, Can I take this up?

Santosh1176 commented 2 years ago

Thanks, @shalier. Do you want me to remove all instances of $ and # from the docs or is there any specific set of docs where this needs to be done?

shalier commented 2 years ago

@Santosh1176 Removing all instances of $ should be enough since that actively affects the copied code. # shouldn't affect the copied code so we're good to leave it. I didn't have a specific set of docs in mind, but I think anywhere that we have copyable code should be looked at.

Thanks for working on this!