Contextual AI for codeblocks #2675
Merged
Conversation
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
pwizla added source: repo 
| The latest updates on your projects. Learn more about Vercel for GitHub.
|
since we simplified the architecture and only "swizzle" the default Code block from Docusaurus 3.x
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
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.
This PR adds an "Ask AI" button to codeblocks, next to the Copy and Wrap buttons.
When clicked, the button automatically opens the Kapa AI modal with a prefilled prompt that asks to explain the code, and you'll quickly get an answer. With follow-up questions you can now get tailored explanations and examples for your use case.
contextual-ai-for-codeblocks.mp4
To achieve this, we swizzled the core code block component from Docusaurus and inject a button in the button group, but only after checking that the code block is "worth it": We're excluding short code blocks (cutoff currently set at 30 characters) and some 'basic' commands such as
npm install,yarn add, etc.All of these are configurable directly within the
/src/theme/CodeBlock/index.jsfile.main.