Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
note to self: visual nit, "copied" message is cut off by the code block element |
Contributor
Author
fix: overflow in Step component was actually causing this, I noticed it in other docs in prod, specifically in code blocks in the Step component :D recent commit fixes it globally |
Member
|
let's park this PR in draft until we find a use case for this it's a cool feature but feels underbaked since we're not applying it to any specific situation or use case yet. maybe we can find an opportunity in error tracking |
Contributor
Author
|
closing this for preference of #14226 |
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.
Changes
what if you could edit code snippets in docs and copy and paste working code, without the back and forth of updating boilerplate code w/ placeholders?
this PR adds edit mode to code blocks, useful for docs where users need to customize their config (API keys, hosts, etc.) before copying.
here's how I built it:
editprop for code blocks (CodeBlockProps,SingleCodeBlockProps,MdxCodeBlock, andMetaStringPropstypes)editedCodestate tracks user changes w/originalCodestoring initial code for reset<SingleCodeBlock edit>and<CodeBlock edit={true}>hover:bg-accentinstead of `hover:bg-light)Behavior:
To test
Try it out on this page: https://posthog-git-code-generator-post-hog.vercel.app/docs/experiments/installation/web
^^this is just a test section to test the functionality, we can assess where it makes sense to use this