Skip to content

fix(readme): strip $ prompt prefix from shell code blocks#119

Merged
jsedding merged 1 commit into
adobe:mainfrom
bpauli:issue118-readme-prompt-prefix
May 13, 2026
Merged

fix(readme): strip $ prompt prefix from shell code blocks#119
jsedding merged 1 commit into
adobe:mainfrom
bpauli:issue118-readme-prompt-prefix

Conversation

@bpauli

@bpauli bpauli commented May 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes the leading $ prompt prefix from every shell code block in README.md.
  • GitHub and npmjs.com copy buttons copy contents verbatim, so users were pasting $ aio … into their shells and getting command not found: $.
  • Modern README convention (npm, Vercel, Stripe docs, etc.) is to omit the prompt for this reason.

Closes #118

Test plan

  • Render the README on GitHub and click the copy button on each code block.
  • Confirm the pasted content is a runnable command with no leading $.

GitHub and npmjs.com copy buttons copy verbatim, so the leading `$ `
gets pasted into the user's shell, which then errors with
`command not found: $`. Removing the prefix makes every code block
copy-pastable as-is.

Closes adobe#118
@jsedding jsedding merged commit aa620f7 into adobe:main May 13, 2026
3 checks passed
@jsedding

Copy link
Copy Markdown
Collaborator

Thank you for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: copy buttons include leading $ prompt prefix

2 participants