search

gitname / react-gh-pages

Deploying a React App (created using create-react-app) to GitHub Pages
6.47k stars 913 forks source link

Remove `$ ` prefix because it was copied when copying the command #150

Open aakarshan-raj opened 1 year ago

gitname commented 1 year ago

Hi @aakarshan-raj, thanks for proposing these changes.

At first glance at the changes, I was on board with making them, except that I was going to request that you (a) delete the two spaces that used to be occupied by the $ that you removed; and (b) restore the $ before the commands that appear within paragraphs, since that makes it easier for me to identify shell commands within paragraphs.

However, as I was drafting a reply containing those requests, I remembered that some of the code snippets in this repository also contain example output (which I do not want readers to copy/paste into their shells). So, I'm not ready to strip out the $ prefixes just yet, because I don't know how I would then distinguish the example output from the command, itself (currently, I use the $ prefix to distinguish them).

I'll think about how I could facilitate copy/pasting, while also distinguishing the commands from the example output.

gitname commented 1 year ago

I may just include a note saying that the $ prefix represents the shell prompt, and I don't intend for readers to include that in the commands they issue.