Add global installation method selector and sync code blocks#1
Merged
Conversation
… code block prefixing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR introduces a global installation method selector (
npx,npm,wp-cli) to the Docusaurus navbar and syncs the selected method globally across the homepage and all documentation code blocks.Why
Previously, the installation method (e.g., using
npx pressshipvswp ship) was only a local state on the homepage, while the documentation hardcoded commands using eithernpx pressshiporpressship. This meant users who preferredwp-clihad to mentally translate commands while reading the docs. By persisting this choice inlocalStorageand syncing it globally, we ensure users get a tailored, consistent reading experience across the entire site.How
InstallMethodContextinsrc/theme/Root.tsxto handle cross-tablocalStoragesyncing and state management globally.NavbarItem/ComponentTypesto insert acustom-installMethodcomponent into the top right of the Docusaurus navbar.CodeBlockcomponent (src/theme/CodeBlock/index.tsx) to dynamically replacenpx pressshipandpressshipprefixes with the user's selected method using RegExp. This automatically applies to allbashandshcode blocks in.mdfiles without needing to write custom React components for every snippet.src/pages/index.tsxso the homepage terminal examples now simply consume the global Context.Notes for the Future
Currently, we use a two-step RegExp inside the
CodeBlockwrapper to catch bothnpx pressshipand barepressshipprefixes (due to mixed usage across our docs). If we standardize the command formatting in the raw markdown files in the future, we can simplify this RegExp significantly, or even replace it entirely with a native Docusaurus feature (like MDX variables) to make it more resilient.